Fix issues with documentations (#280)

* Some fixes for documentations * Use autodoc mock import
equinor · Dec 21, 2022 · 57dd0a1 · 57dd0a1
1 parent 6f889f8
commit 57dd0a1
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 2 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -59,6 +59,9 @@
 autodoc_member_order = "bysource"
 autodoc_default_flags = ["members", "show_inheritance"]
 
+# Mocking ert module
+autodoc_mock_imports = ["ert"]
+
 exclude_patterns = ["_build"]
 
 pygments_style = "sphinx"

diff --git a/docs/examples.rst b/docs/examples.rst
@@ -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
 
 |
@@ -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
 
 |

diff --git a/docs/preparations.rst b/docs/preparations.rst
@@ -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