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.

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

Docs work: mainly surface obs #145

Draft
wants to merge 22 commits into
base: develop
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
145 changes: 143 additions & 2 deletions docs/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
API
===

.. module:: monetio
:synopsis: Data input/output for MONET

.. contents::
:depth: 3
:local:
Expand All @@ -19,7 +22,10 @@ for example, :func:`monetio.aeronet.add_data`.
AERONET
^^^^^^^

See :ref:`observations:AERONET` for more information.
.. automodule:: monetio.aeronet

Functions
+++++++++

.. autosummary::

Expand All @@ -34,18 +40,141 @@ See :ref:`observations:AERONET` for more information.
AirNow
^^^^^^

See :ref:`observations:AirNow` for more information.
.. automodule:: monetio.airnow

Functions
+++++++++

.. autosummary::

monetio.airnow.add_data
monetio.airnow.read_csv

.. autofunction:: monetio.airnow.add_data
.. autofunction:: monetio.airnow.read_csv

AQS
^^^

.. automodule:: monetio.aqs

Functions
+++++++++

.. autosummary::

monetio.aqs.add_data

.. autofunction:: monetio.aqs.add_data


CEMS
^^^^

.. autoclass:: monetio.obs.cems_mod.CEMS

Functions
+++++++++

(Available under :mod:`monetio` namespace.)

.. automethod:: monetio.cems.add_data

CRN
^^^

.. automodule:: monetio.crn

Functions
+++++++++

.. autosummary::

monetio.crn.add_data

.. autofunction:: monetio.crn.add_data

IMPROVE
^^^^^^^

.. autoclass:: monetio.obs.improve_mod.IMPROVE

Functions
+++++++++

(Available under :mod:`monetio` namespace.)

.. automethod:: monetio.improve.add_data

ISH
^^^

.. automodule:: monetio.ish

Functions
+++++++++

.. autosummary::

monetio.ish.add_data

.. autofunction:: monetio.ish.add_data


ISH-lite
^^^^^^^^

.. automodule:: monetio.ish_lite

Functions
+++++++++

.. autosummary::

monetio.ish_lite.add_data

.. autofunction:: monetio.ish_lite.add_data

NADP
^^^^

.. automodule:: monetio.nadp

Functions
+++++++++

.. autosummary::

monetio.nadp.add_data

.. autofunction:: monetio.nadp.add_data


OpenAQ
^^^^^^

TODO

PAMS
^^^^

.. automodule:: monetio.pams

Functions
+++++++++

.. autosummary::

monetio.pams.add_data

.. autofunction:: monetio.pams.add_data

Profile observations
--------------------

GEOMS
^^^^^

.. automodule:: monetio.geoms

.. autosummary::
Expand All @@ -55,6 +184,18 @@ Profile observations
.. autofunction:: monetio.geoms.open_dataset


ICARTT
^^^^^^

.. automodule:: monetio.icartt

.. autosummary::

monetio.icartt.add_data

.. autofunction:: monetio.icartt.add_data


Utility functions
=================

Expand Down
4 changes: 4 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
"sphinx.ext.extlinks",
"sphinx.ext.intersphinx",
"sphinx.ext.autosectionlabel",
"myst_nb",
]

# Add any paths that contain templates here, relative to this directory.
Expand Down Expand Up @@ -109,6 +110,9 @@
autosectionlabel_prefix_document = True
autosectionlabel_maxdepth = 2

# MyST NB
nb_execution_mode = "off"

# -- Options for HTML output -------------------------------------------------

# The theme to use for HTML and HTML Help pages. See the documentation for
Expand Down
5 changes: 4 additions & 1 deletion docs/environment-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,19 @@ dependencies:
- dask
- netcdf4
- numpy
- pandas
- pandas <2
- s3fs
- scipy
- xarray
#
# optional
- joblib
- lxml
- requests
#
# docs
- jupyterlab
- myst-nb
- sphinx=4.*
- sphinx-autobuild
- sphinx_rtd_theme
Expand Down
Loading