Merge pull request #311 from Deltares/docs/general-docs-fix

Docs/general docs fix
Deltares · Mar 8, 2024 · 4756b99 · 4756b99
2 parents e8a9396 + dd34b2c
commit 4756b99
Show file tree

Hide file tree

Showing 9 changed files with 28 additions and 291 deletions.
diff --git a/docs/analysis_module/analysis_module.rst b/docs/analysis_module/analysis_module.rst
@@ -368,7 +368,9 @@ This analysis finds the shortest (distance-weighed) or quickest (time-weighed) r
 This analysis finds the sections of the network that are fully isolated from the rest of the network (also named disconnected islands), because of network disruption due to a hazard.
 
 **network.ini**
+
 ::
+
     [project]
     name = example_indirect
 
@@ -403,9 +405,12 @@ This analysis finds the sections of the network that are fully isolated from the
     [isolation]
     locations = origins_worldpop_wgs84.shp
 
+
 **analyses.ini**
+
 ::
-    project]
+
+    [project]
     name = example_indirect
 
     [analysis1]

diff --git a/docs/conf.py b/docs/conf.py
@@ -66,7 +66,6 @@ def remove_dir_content(path: str) -> None:
     "sphinx.ext.viewcode",
     "sphinx.ext.githubpages",
     "sphinx.ext.napoleon",
-    "sphinx.ext.autosectionlabel",
     "sphinx.ext.autosummary",
     "sphinx_autosummary_accessors",
     "nbsphinx",

diff --git a/docs/contributing/index.rst b/docs/contributing/index.rst
@@ -47,7 +47,6 @@ Implement Features
 Look through the GitHub issues for features. Anything tagged with "enhancement"
 and "help wanted" is open to whoever wants to implement it.
 
-
 .. _Writing tests:
 
 Writing tests
@@ -150,6 +149,9 @@ If you are proposing a feature:
 * Remember that this is a volunteer-driven project, and that contributions
   are welcome :)
 
+..
+  The following table of contents is hidden as we don't need to display it.
+  However, it will bind those items to this one in the "section menu".
 
 .. toctree::
    :caption: Table of Contents

diff --git a/docs/docker/docker_user_guide.rst b/docs/docker/docker_user_guide.rst
diff --git a/docs/examples/examples.rst b/docs/examples/examples.rst
@@ -17,7 +17,7 @@ Bellow you can access some of the main examples and go through them in an off-li
 .. toctree::
    :maxdepth: 1
    :caption: Examples
-
+   
    ../_examples/example_ra2ce_basics
    ../_examples/example_single_link_redundancy
    ../_examples/example_origin_destination_analysis

diff --git a/docs/faq/faq.rst b/docs/faq/faq.rst
@@ -8,14 +8,16 @@ This page contains the most frequently asked questions about working with RA2CE.
 Installation
 ------------------------------
 
- | **Q**: What to do if my environment fails to install at the `conda env create -f .config\environment.yml` step?
+| **Q**: What to do if my environment fails to install at the `conda env create -f .config\environment.yml` step?
 
 When install poetry 1.3.2 (1.4.*) gives issues: install it manually with::
-    
+
+::
+
     conda install -c conda-forge poetry=1.3.2
-..
 
- | **Q**: What to do if my environment fails to install at the `poetry install` step?
+
+| **Q**: What to do if my environment fails to install at the `poetry install` step?
 
 Try to run `poetry install` again.
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -20,9 +20,8 @@ Or navigate directly to another section:
 
    overview
    installation/installation
-   user_guide/user_guide
    examples/examples
-   collaboration/collaboration
+   contributing/index
    changelog_wrapper
 
 Lost..? Try the :ref:`search`.