Merge pull request #74 from mikapfl/docs

Small fixes for the docs: typos, formatting, links, duplications
C2SM-RCM · Dec 18, 2024 · 159ac77 · 159ac77
2 parents 60e90dc + 14006cf
commit 159ac77
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 4 deletions.
diff --git a/docs/source/api/inventories.rst b/docs/source/api/inventories.rst
@@ -44,4 +44,7 @@ Available Inventories
     :special-members: __init__
 
 .. autoclass:: emiproc.inventories.gral.GralInventory
-    :special-members: __init__
+    :special-members: __init__
+
+.. autoclass:: emiproc.inventories.cams_reg_aq.CAMS_REG_AQ
+    :special-members: __init__
diff --git a/docs/source/emissions_generation.rst b/docs/source/emissions_generation.rst
@@ -32,4 +32,4 @@ Human Respiration
 Human respirations can be generated using maps of population density and 
 emission factors per person.
 
-see :py:mod:`emiproc.human_respiration
+see :py:mod:`emiproc.human_respiration`
diff --git a/docs/source/tutos/tutorials.rst b/docs/source/tutos/tutorials.rst
@@ -4,8 +4,8 @@ Tutorials
 If you want to start using emiproc, we recommend beginning with the tutorials below.
 They will guide you through the main features of emiproc.
 
-Additionally many examples of using emiproc can be found
 Additionally, many examples of using emiproc can be found in the GitHub repository.
+
 Examples 
 --------
 
@@ -17,7 +17,6 @@ https://github.com/C2SM-RCM/emiproc/tree/master/examples
 Scripts 
 -------
 
-Scripts were create on some dedicated cases. They are not well documented
 Scripts were created for some dedicated cases. They are not well documented, but there are many scripts for different cases.
 https://github.com/C2SM-RCM/emiproc/tree/master/scripts
 

diff --git a/pyproject.toml b/pyproject.toml
@@ -67,5 +67,6 @@ doc = [
     "enum-tools",
     "sphinx_toolbox",
     "nbsphinx",
+    "ipython",
 ]
 dev = ["black", "pytest"]