-
Notifications
You must be signed in to change notification settings - Fork 15
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fix issues with documentations #280
Conversation
@jcrivenaes @perolavsvendsen can you please check this PR? |
Is the ERT dependency actually needed or can it be mocked (just imported, never used)? https://stackoverflow.com/a/56918885/8381388 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am fine with it 👍 But consider the comment about ert
import. If it should be mocked.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good 👍
Nice. I didn't know about autodoc mocking feature. I have now put it in and it works great. I don't have write access to the repo. Can someone help me merge it? |
You should have write access now 👍 |
Thanks @perolavsvendsen |
There are a few issues when building Sphinx docs
I have modified the file path to files generated by run_examples.sh script
Add 1 line break make the code-blocks appear in the documentation
dataio.scripts.create_case_metadata module has reference to ert_shared (ert library) which is not specified in requirements