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

Small fixes for the docs: typos, formatting, links, duplications #74

Merged
merged 5 commits into from
Dec 18, 2024
Merged

Small fixes for the docs: typos, formatting, links, duplications #74

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3aa1924
Add ipython as docs dependency for syntax highlighting
mikapfl Dec 18, 2024
efb73d7
Add cams_reg_aq.CAMS_REG_AQ to API docs
mikapfl Dec 18, 2024
1883eff
Typos and formatting in the tutorial docs
mikapfl Dec 18, 2024
bd42053
remove more duplicates in the docs
mikapfl Dec 18, 2024
14006cf
fix link in docs
mikapfl Dec 18, 2024
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
5 changes: 4 additions & 1 deletion docs/source/api/inventories.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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__
2 changes: 1 addition & 1 deletion docs/source/emissions_generation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`
3 changes: 1 addition & 2 deletions docs/source/tutos/tutorials.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
--------

Expand All @@ -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

Expand Down
1 change: 1 addition & 0 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,5 +67,6 @@ doc = [
"enum-tools",
"sphinx_toolbox",
"nbsphinx",
"ipython",
]
dev = ["black", "pytest"]
Loading