diff --git a/docs/conf.py b/docs/conf.py index 93e7610ec..894c74a95 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -28,6 +28,7 @@ # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. extensions = [ "sphinx.ext.autodoc", + "sphinx.ext.autosummary", "sphinx.ext.autosectionlabel", "sphinx.ext.doctest", "sphinx.ext.intersphinx", @@ -105,6 +106,7 @@ # objects without namespace: pint "Quantity": "~pint.Quantity", "Unit": "~pint.Unit", + "UnitsContainer": "~pint.UnitsContainer", # objects without namespace: numpy "ndarray": "~numpy.ndarray", "MaskedArray": "~numpy.ma.MaskedArray", diff --git a/docs/dev/developers_reference.rst b/docs/dev/developers_reference.rst index 19ce3cb7d..8b5772fef 100644 --- a/docs/dev/developers_reference.rst +++ b/docs/dev/developers_reference.rst @@ -1,12 +1,9 @@ =================== -Developer reference +API reference =================== -All Modules -=========== +.. currentmodule:: pint -.. automodule:: pint - :members: .. automodule:: pint.babel_names :members: @@ -14,6 +11,9 @@ All Modules .. automodule:: pint.compat :members: +.. automodule:: pint.context + :members: + .. automodule:: pint.converters :members: @@ -29,47 +29,26 @@ All Modules .. automodule:: pint.matplotlib :members: -.. automodule:: pint.pint_eval - :members: - -.. automodule:: pint.registry - :members: - -.. automodule:: pint.registry_helpers - :members: - -.. automodule:: pint.testing +.. automodule:: pint.measurement :members: -.. automodule:: pint.util - :members: - -Facets ------- - -.. automodule:: pint.facets.plain - :members: - -.. automodule:: pint.facets.nonmultiplicative - :members: - -.. automodule:: pint.facets.formatting +.. automodule:: pint.pint_eval :members: -.. automodule:: pint.facets.numpy +.. automodule:: pint.quantity :members: -.. automodule:: pint.facets.dask +.. automodule:: pint.registry :members: -.. automodule:: pint.facets.measurement +.. automodule:: pint.registry_helpers :members: -.. automodule:: pint.facets.group +.. automodule:: pint.systems :members: .. automodule:: pint.facets.system :members: -.. automodule:: pint.facets.context +.. automodule:: pint.util :members: diff --git a/docs/index.rst b/docs/index.rst index 75a6e6fec..ce4182e31 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -122,18 +122,12 @@ of the output quantity will be radian. Going Further user/ecosystem -.. toctree:: - :maxdepth: 2 - :hidden: - :caption: API Reference - - dev/developers_reference - .. toctree:: :maxdepth: 1 :hidden: :caption: For developers + dev/developers_reference dev/contributing dev/pint-convert @@ -148,7 +142,6 @@ of the output quantity will be radian. One last thing -------------- -.. epigraph:: The MCO MIB has determined that the root cause for the loss of the MCO spacecraft was the failure to use metric units in the coding of a ground software file, “Small Forces,” used in trajectory models. Specifically, thruster performance data in English units instead of metric units was used in the software application code titled SM_FORCES (small forces). The output from the SM_FORCES application code as required by a MSOP Project Software Interface Specification (SIS) was to be in metric units of Newtonseconds (N-s). Instead, the data was reported in English units of pound-seconds (lbf-s). The Angular Momentum Desaturation (AMD) file contained the output data from the SM_FORCES software. The SIS, which was not followed, defines both the format and units of the AMD file generated by ground-based computers. Subsequent processing of the data from AMD file by the navigation software algorithm therefore, underestimated the effect on the spacecraft trajectory by a factor of 4.45, which is the required conversion factor from force in pounds to Newtons. An erroneous trajectory was computed using this incorrect data.