From 314ce0cb43cbae50b3bd947be7e3c1ca80c600de Mon Sep 17 00:00:00 2001 From: LukasK13 Date: Mon, 6 Jul 2020 17:28:44 +0200 Subject: [PATCH] API documentation added --- docs/source/api/api.rst | 7 ++ .../esbo_etc.classes.optical_component.rst | 86 +++++++++++++++++++ docs/source/api/esbo_etc.classes.psf.rst | 38 ++++++++ docs/source/api/esbo_etc.classes.rst | 73 ++++++++++++++++ docs/source/api/esbo_etc.classes.sensor.rst | 54 ++++++++++++ docs/source/api/esbo_etc.classes.target.rst | 46 ++++++++++ docs/source/api/esbo_etc.lib.rst | 38 ++++++++ docs/source/api/esbo_etc.rst | 31 +++++++ docs/source/api/modules.rst | 7 ++ docs/source/conf.py | 18 +++- docs/source/index.rst | 1 + 11 files changed, 396 insertions(+), 3 deletions(-) create mode 100644 docs/source/api/api.rst create mode 100644 docs/source/api/esbo_etc.classes.optical_component.rst create mode 100644 docs/source/api/esbo_etc.classes.psf.rst create mode 100644 docs/source/api/esbo_etc.classes.rst create mode 100644 docs/source/api/esbo_etc.classes.sensor.rst create mode 100644 docs/source/api/esbo_etc.classes.target.rst create mode 100644 docs/source/api/esbo_etc.lib.rst create mode 100644 docs/source/api/esbo_etc.rst create mode 100644 docs/source/api/modules.rst diff --git a/docs/source/api/api.rst b/docs/source/api/api.rst new file mode 100644 index 0000000..3974834 --- /dev/null +++ b/docs/source/api/api.rst @@ -0,0 +1,7 @@ +.. _api: + +***************** +API Documentation +***************** + +.. include:: esbo_etc.rst \ No newline at end of file diff --git a/docs/source/api/esbo_etc.classes.optical_component.rst b/docs/source/api/esbo_etc.classes.optical_component.rst new file mode 100644 index 0000000..505adfd --- /dev/null +++ b/docs/source/api/esbo_etc.classes.optical_component.rst @@ -0,0 +1,86 @@ +esbo\_etc.classes.optical\_component package +============================================ + +Submodules +---------- + +esbo\_etc.classes.optical\_component.AHotOpticalComponent module +---------------------------------------------------------------- + +.. automodule:: esbo_etc.classes.optical_component.AHotOpticalComponent + :members: + :undoc-members: + :show-inheritance: + +esbo\_etc.classes.optical\_component.AOpticalComponent module +------------------------------------------------------------- + +.. automodule:: esbo_etc.classes.optical_component.AOpticalComponent + :members: + :undoc-members: + :show-inheritance: + +esbo\_etc.classes.optical\_component.Atmosphere module +------------------------------------------------------ + +.. automodule:: esbo_etc.classes.optical_component.Atmosphere + :members: + :undoc-members: + :show-inheritance: + +esbo\_etc.classes.optical\_component.BeamSplitter module +-------------------------------------------------------- + +.. automodule:: esbo_etc.classes.optical_component.BeamSplitter + :members: + :undoc-members: + :show-inheritance: + +esbo\_etc.classes.optical\_component.CosmicBackground module +------------------------------------------------------------ + +.. automodule:: esbo_etc.classes.optical_component.CosmicBackground + :members: + :undoc-members: + :show-inheritance: + +esbo\_etc.classes.optical\_component.Filter module +-------------------------------------------------- + +.. automodule:: esbo_etc.classes.optical_component.Filter + :members: + :undoc-members: + :show-inheritance: + +esbo\_etc.classes.optical\_component.Lens module +------------------------------------------------ + +.. automodule:: esbo_etc.classes.optical_component.Lens + :members: + :undoc-members: + :show-inheritance: + +esbo\_etc.classes.optical\_component.Mirror module +-------------------------------------------------- + +.. automodule:: esbo_etc.classes.optical_component.Mirror + :members: + :undoc-members: + :show-inheritance: + +esbo\_etc.classes.optical\_component.StrayLight module +------------------------------------------------------ + +.. automodule:: esbo_etc.classes.optical_component.StrayLight + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: esbo_etc.classes.optical_component + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/esbo_etc.classes.psf.rst b/docs/source/api/esbo_etc.classes.psf.rst new file mode 100644 index 0000000..4041af4 --- /dev/null +++ b/docs/source/api/esbo_etc.classes.psf.rst @@ -0,0 +1,38 @@ +esbo\_etc.classes.psf package +============================= + +Submodules +---------- + +esbo\_etc.classes.psf.Airy module +--------------------------------- + +.. automodule:: esbo_etc.classes.psf.Airy + :members: + :undoc-members: + :show-inheritance: + +esbo\_etc.classes.psf.IPSF module +--------------------------------- + +.. automodule:: esbo_etc.classes.psf.IPSF + :members: + :undoc-members: + :show-inheritance: + +esbo\_etc.classes.psf.Zemax module +---------------------------------- + +.. automodule:: esbo_etc.classes.psf.Zemax + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: esbo_etc.classes.psf + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/esbo_etc.classes.rst b/docs/source/api/esbo_etc.classes.rst new file mode 100644 index 0000000..466c37d --- /dev/null +++ b/docs/source/api/esbo_etc.classes.rst @@ -0,0 +1,73 @@ +esbo\_etc.classes package +========================= + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + esbo_etc.classes.optical_component + esbo_etc.classes.psf + esbo_etc.classes.sensor + esbo_etc.classes.target + +Submodules +---------- + +esbo\_etc.classes.Config module +------------------------------- + +.. automodule:: esbo_etc.classes.Config + :members: + :undoc-members: + :show-inheritance: + +esbo\_etc.classes.Entry module +------------------------------ + +.. automodule:: esbo_etc.classes.Entry + :members: + :undoc-members: + :show-inheritance: + +esbo\_etc.classes.IRadiant module +--------------------------------- + +.. automodule:: esbo_etc.classes.IRadiant + :members: + :undoc-members: + :show-inheritance: + +esbo\_etc.classes.RadiantFactory module +--------------------------------------- + +.. automodule:: esbo_etc.classes.RadiantFactory + :members: + :undoc-members: + :show-inheritance: + +esbo\_etc.classes.SpectralQty module +------------------------------------ + +.. automodule:: esbo_etc.classes.SpectralQty + :members: + :undoc-members: + :show-inheritance: + +esbo\_etc.classes.SpinnerHandler module +--------------------------------------- + +.. automodule:: esbo_etc.classes.SpinnerHandler + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: esbo_etc.classes + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/esbo_etc.classes.sensor.rst b/docs/source/api/esbo_etc.classes.sensor.rst new file mode 100644 index 0000000..5deb9dd --- /dev/null +++ b/docs/source/api/esbo_etc.classes.sensor.rst @@ -0,0 +1,54 @@ +esbo\_etc.classes.sensor package +================================ + +Submodules +---------- + +esbo\_etc.classes.sensor.ASensor module +--------------------------------------- + +.. automodule:: esbo_etc.classes.sensor.ASensor + :members: + :undoc-members: + :show-inheritance: + +esbo\_etc.classes.sensor.Heterodyne module +------------------------------------------ + +.. automodule:: esbo_etc.classes.sensor.Heterodyne + :members: + :undoc-members: + :show-inheritance: + +esbo\_etc.classes.sensor.Imager module +-------------------------------------- + +.. automodule:: esbo_etc.classes.sensor.Imager + :members: + :undoc-members: + :show-inheritance: + +esbo\_etc.classes.sensor.PixelMask module +----------------------------------------- + +.. automodule:: esbo_etc.classes.sensor.PixelMask + :members: + :undoc-members: + :show-inheritance: + +esbo\_etc.classes.sensor.SensorFactory module +--------------------------------------------- + +.. automodule:: esbo_etc.classes.sensor.SensorFactory + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: esbo_etc.classes.sensor + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/esbo_etc.classes.target.rst b/docs/source/api/esbo_etc.classes.target.rst new file mode 100644 index 0000000..66fad46 --- /dev/null +++ b/docs/source/api/esbo_etc.classes.target.rst @@ -0,0 +1,46 @@ +esbo\_etc.classes.target package +================================ + +Submodules +---------- + +esbo\_etc.classes.target.ATarget module +--------------------------------------- + +.. automodule:: esbo_etc.classes.target.ATarget + :members: + :undoc-members: + :show-inheritance: + +esbo\_etc.classes.target.BlackBodyTarget module +----------------------------------------------- + +.. automodule:: esbo_etc.classes.target.BlackBodyTarget + :members: + :undoc-members: + :show-inheritance: + +esbo\_etc.classes.target.FileTarget module +------------------------------------------ + +.. automodule:: esbo_etc.classes.target.FileTarget + :members: + :undoc-members: + :show-inheritance: + +esbo\_etc.classes.target.LineTarget module +------------------------------------------ + +.. automodule:: esbo_etc.classes.target.LineTarget + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: esbo_etc.classes.target + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/esbo_etc.lib.rst b/docs/source/api/esbo_etc.lib.rst new file mode 100644 index 0000000..92f6d92 --- /dev/null +++ b/docs/source/api/esbo_etc.lib.rst @@ -0,0 +1,38 @@ +esbo\_etc.lib package +===================== + +Submodules +---------- + +esbo\_etc.lib.helpers module +---------------------------- + +.. automodule:: esbo_etc.lib.helpers + :members: + :undoc-members: + :show-inheritance: + +esbo\_etc.lib.logger module +--------------------------- + +.. automodule:: esbo_etc.lib.logger + :members: + :undoc-members: + :show-inheritance: + +esbo\_etc.lib.output module +--------------------------- + +.. automodule:: esbo_etc.lib.output + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: esbo_etc.lib + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/esbo_etc.rst b/docs/source/api/esbo_etc.rst new file mode 100644 index 0000000..2ca3be0 --- /dev/null +++ b/docs/source/api/esbo_etc.rst @@ -0,0 +1,31 @@ +esbo\_etc package +================= + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + esbo_etc.classes + esbo_etc.lib + +Submodules +---------- + +esbo\_etc.esbo\-etc module +-------------------------- + +.. automodule:: esbo_etc.esbo-etc + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: esbo_etc + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/modules.rst b/docs/source/api/modules.rst new file mode 100644 index 0000000..5bc26f0 --- /dev/null +++ b/docs/source/api/modules.rst @@ -0,0 +1,7 @@ +esbo_etc +======== + +.. toctree:: + :maxdepth: 4 + + esbo_etc diff --git a/docs/source/conf.py b/docs/source/conf.py index 1abed5c..91ea953 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -31,7 +31,7 @@ release = '1.0.0' # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. -extensions = ["sphinx_rtd_theme", "sphinx.ext.todo"] +extensions = ["sphinx_rtd_theme", "sphinx.ext.todo", "sphinx.ext.napoleon"] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -42,7 +42,6 @@ templates_path = ['_templates'] exclude_patterns = ['configuration/target.rst', 'configuration/common.rst', 'configuration/optical_components.rst', 'configuration/sensor.rst'] - # -- Options for HTML output ------------------------------------------------- html_show_sourcelink = False @@ -55,4 +54,17 @@ html_logo = '_static/ESBOds_LOGO.png' # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] \ No newline at end of file +html_static_path = ['_static'] + +# Napoleon settings +napoleon_google_docstring = False +napoleon_numpy_docstring = True +napoleon_include_init_with_doc = True +napoleon_include_private_with_doc = False +napoleon_include_special_with_doc = True +napoleon_use_admonition_for_examples = False +napoleon_use_admonition_for_notes = False +napoleon_use_admonition_for_references = False +napoleon_use_ivar = False +napoleon_use_param = True +napoleon_use_rtype = False diff --git a/docs/source/index.rst b/docs/source/index.rst index 9fc38ec..7db647e 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -15,6 +15,7 @@ Welcome to ESBO-ETC's documentation! usage/getting_started configuration/configuration developer/developer_documentation + api/api .. ******************