Skip to content
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

Merged
merged 3 commits into from
Dec 21, 2022
Merged

Fix issues with documentations #280

merged 3 commits into from
Dec 21, 2022

Conversation

alifbe
Copy link
Contributor

@alifbe alifbe commented Dec 19, 2022

There are a few issues when building Sphinx docs

  • Missing/wrong file link (issue Documentation has "expand" sections that does not work #271):
    I have modified the file path to files generated by run_examples.sh script
  • Missing spacing in code-blocks
    Add 1 line break make the code-blocks appear in the documentation
  • Missing reference to ert library
    dataio.scripts.create_case_metadata module has reference to ert_shared (ert library) which is not specified in requirements

@alifbe
Copy link
Contributor Author

alifbe commented Dec 19, 2022

@jcrivenaes @perolavsvendsen can you please check this PR?

@perolavsvendsen
Copy link
Member

Is the ERT dependency actually needed or can it be mocked (just imported, never used)? https://stackoverflow.com/a/56918885/8381388

Copy link
Member

@perolavsvendsen perolavsvendsen left a 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.

Copy link
Collaborator

@jcrivenaes jcrivenaes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good 👍

@alifbe
Copy link
Contributor Author

alifbe commented Dec 20, 2022

I am fine with it +1 But consider the comment about ert import. If it should be mocked.

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?

@perolavsvendsen
Copy link
Member

I don't have write access to the repo. Can someone help me merge it?

You should have write access now 👍

@alifbe
Copy link
Contributor Author

alifbe commented Dec 21, 2022

I don't have write access to the repo. Can someone help me merge it?

You should have write access now 👍

Thanks @perolavsvendsen

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants