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.

Sign up for GitHub

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

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d821350
Some fixes for documentations
alifbe Dec 19, 2022
fdab123
Move ert to requirements_docs.txt
alifbe Dec 19, 2022
edeea85
Use autodoc mock import
alifbe Dec 20, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/examples.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Press + to see generated YAML file.

.. toggle::

.. literalinclude:: ../examples/s/d/nn/xcase/realization-0/iter-0/share/results/polygons/.topvolantis--faultlines.pol.yml
.. literalinclude:: ../examples/s/d/nn/xcase/realization-0/iter-0/share/results/polygons/.volantis_gp_top--faultlines.pol.yml
:language: yaml

|
Expand Down Expand Up @@ -78,7 +78,7 @@ Press + to see generated YAML files for metadata.

.. toggle::

.. literalinclude:: ../examples/s/d/nn/xcase/realization-0/iter-0/share/results/grids/.geogrid--facies.roff.yml
.. literalinclude:: ../examples/s/d/nn/xcase/realization-0/iter-0/share/results/grids/.facies.roff.yml
:language: yaml

|
Expand Down
1 change: 1 addition & 0 deletions docs/preparations.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -228,6 +228,7 @@ from the Drogon workflow:
Now, load this workflow in your ERT config file and make it a HOOK workflow:

.. code-block::

-- Hook workflow for creating case metadata and (optional) registering case on Sumo
LOAD_WORKFLOW ../../bin/workflows/xhook_create_case_metadata
HOOK_WORKFLOW xhook_create_case_metadata PRE_SIMULATION
Expand Down
1 change: 1 addition & 0 deletions requirements/requirements_docs.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@ autoapi
sphinx-autodoc-typehints
sphinxcontrib-apidoc
sphinx-togglebutton
ert