From 53e6cf31cfa77d952b827e6912d5fb12758f0ab3 Mon Sep 17 00:00:00 2001 From: alexhroom Date: Mon, 10 Feb 2025 12:16:06 +0000 Subject: [PATCH 1/3] updated API reference --- docs/api/modules.rst | 7 ++++ docs/api/orsopy.fileio.base.rst | 7 ++++ docs/api/orsopy.fileio.data_source.rst | 7 ++++ docs/api/orsopy.fileio.model_language.rst | 7 ++++ docs/api/orsopy.fileio.orso.rst | 7 ++++ docs/api/orsopy.fileio.reduction.rst | 7 ++++ docs/api/orsopy.fileio.rst | 23 +++++++++++++ docs/api/orsopy.fileio.typing_backport.rst | 7 ++++ docs/api/orsopy.orb2ort.rst | 7 ++++ docs/api/orsopy.ort2orb.rst | 7 ++++ docs/api/orsopy.rst | 29 ++++++++++++++++ docs/api/orsopy.slddb.comparators.rst | 7 ++++ docs/api/orsopy.slddb.constants.rst | 7 ++++ docs/api/orsopy.slddb.converters.rst | 7 ++++ docs/api/orsopy.slddb.database.rst | 7 ++++ docs/api/orsopy.slddb.dbconfig.rst | 7 ++++ .../orsopy.slddb.element_table.element.rst | 7 ++++ .../api/orsopy.slddb.element_table.masses.rst | 7 ++++ ...orsopy.slddb.element_table.nabs_geant4.rst | 7 ++++ .../orsopy.slddb.element_table.nlengths.rst | 7 ++++ ...orsopy.slddb.element_table.nlengths_pt.rst | 7 ++++ docs/api/orsopy.slddb.element_table.rst | 24 ++++++++++++++ .../orsopy.slddb.element_table.xray_henke.rst | 7 ++++ .../orsopy.slddb.element_table.xray_nist.rst | 7 ++++ docs/api/orsopy.slddb.importers.rst | 7 ++++ docs/api/orsopy.slddb.material.rst | 7 ++++ docs/api/orsopy.slddb.rst | 33 +++++++++++++++++++ docs/api/orsopy.slddb.webapi.rst | 7 ++++ docs/api/orsopy.utils.chemical_formula.rst | 7 ++++ docs/api/orsopy.utils.density_resolver.rst | 7 ++++ docs/api/orsopy.utils.resolver_slddb.rst | 7 ++++ docs/api/orsopy.utils.rst | 20 +++++++++++ docs/index.rst | 2 +- docs/modules.rst | 16 --------- docs/orsopy.fileio.base.rst | 7 ---- docs/orsopy.fileio.data_source.rst | 7 ---- docs/orsopy.fileio.orso.rst | 7 ---- docs/orsopy.fileio.reduction.rst | 7 ---- orsopy/fileio/__init__.py | 3 +- requirements_dev.txt | 1 + 40 files changed, 322 insertions(+), 46 deletions(-) create mode 100644 docs/api/modules.rst create mode 100644 docs/api/orsopy.fileio.base.rst create mode 100644 docs/api/orsopy.fileio.data_source.rst create mode 100644 docs/api/orsopy.fileio.model_language.rst create mode 100644 docs/api/orsopy.fileio.orso.rst create mode 100644 docs/api/orsopy.fileio.reduction.rst create mode 100644 docs/api/orsopy.fileio.rst create mode 100644 docs/api/orsopy.fileio.typing_backport.rst create mode 100644 docs/api/orsopy.orb2ort.rst create mode 100644 docs/api/orsopy.ort2orb.rst create mode 100644 docs/api/orsopy.rst create mode 100644 docs/api/orsopy.slddb.comparators.rst create mode 100644 docs/api/orsopy.slddb.constants.rst create mode 100644 docs/api/orsopy.slddb.converters.rst create mode 100644 docs/api/orsopy.slddb.database.rst create mode 100644 docs/api/orsopy.slddb.dbconfig.rst create mode 100644 docs/api/orsopy.slddb.element_table.element.rst create mode 100644 docs/api/orsopy.slddb.element_table.masses.rst create mode 100644 docs/api/orsopy.slddb.element_table.nabs_geant4.rst create mode 100644 docs/api/orsopy.slddb.element_table.nlengths.rst create mode 100644 docs/api/orsopy.slddb.element_table.nlengths_pt.rst create mode 100644 docs/api/orsopy.slddb.element_table.rst create mode 100644 docs/api/orsopy.slddb.element_table.xray_henke.rst create mode 100644 docs/api/orsopy.slddb.element_table.xray_nist.rst create mode 100644 docs/api/orsopy.slddb.importers.rst create mode 100644 docs/api/orsopy.slddb.material.rst create mode 100644 docs/api/orsopy.slddb.rst create mode 100644 docs/api/orsopy.slddb.webapi.rst create mode 100644 docs/api/orsopy.utils.chemical_formula.rst create mode 100644 docs/api/orsopy.utils.density_resolver.rst create mode 100644 docs/api/orsopy.utils.resolver_slddb.rst create mode 100644 docs/api/orsopy.utils.rst delete mode 100644 docs/modules.rst delete mode 100644 docs/orsopy.fileio.base.rst delete mode 100644 docs/orsopy.fileio.data_source.rst delete mode 100644 docs/orsopy.fileio.orso.rst delete mode 100644 docs/orsopy.fileio.reduction.rst diff --git a/docs/api/modules.rst b/docs/api/modules.rst new file mode 100644 index 00000000..8b172ea0 --- /dev/null +++ b/docs/api/modules.rst @@ -0,0 +1,7 @@ +orsopy +====== + +.. toctree:: + :maxdepth: 1 + + orsopy diff --git a/docs/api/orsopy.fileio.base.rst b/docs/api/orsopy.fileio.base.rst new file mode 100644 index 00000000..1266cd39 --- /dev/null +++ b/docs/api/orsopy.fileio.base.rst @@ -0,0 +1,7 @@ +orsopy.fileio.base module +========================= + +.. automodule:: orsopy.fileio.base + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/orsopy.fileio.data_source.rst b/docs/api/orsopy.fileio.data_source.rst new file mode 100644 index 00000000..1972dcd0 --- /dev/null +++ b/docs/api/orsopy.fileio.data_source.rst @@ -0,0 +1,7 @@ +orsopy.fileio.data\_source module +================================= + +.. automodule:: orsopy.fileio.data_source + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/orsopy.fileio.model_language.rst b/docs/api/orsopy.fileio.model_language.rst new file mode 100644 index 00000000..7ce71cdb --- /dev/null +++ b/docs/api/orsopy.fileio.model_language.rst @@ -0,0 +1,7 @@ +orsopy.fileio.model\_language module +==================================== + +.. automodule:: orsopy.fileio.model_language + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/orsopy.fileio.orso.rst b/docs/api/orsopy.fileio.orso.rst new file mode 100644 index 00000000..b2dd1df0 --- /dev/null +++ b/docs/api/orsopy.fileio.orso.rst @@ -0,0 +1,7 @@ +orsopy.fileio.orso module +========================= + +.. automodule:: orsopy.fileio.orso + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/orsopy.fileio.reduction.rst b/docs/api/orsopy.fileio.reduction.rst new file mode 100644 index 00000000..2ab1581a --- /dev/null +++ b/docs/api/orsopy.fileio.reduction.rst @@ -0,0 +1,7 @@ +orsopy.fileio.reduction module +============================== + +.. automodule:: orsopy.fileio.reduction + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/orsopy.fileio.rst b/docs/api/orsopy.fileio.rst new file mode 100644 index 00000000..6f42bc7c --- /dev/null +++ b/docs/api/orsopy.fileio.rst @@ -0,0 +1,23 @@ +orsopy.fileio package +===================== + +Submodules +---------- + +.. toctree:: + :maxdepth: 1 + + orsopy.fileio.base + orsopy.fileio.data_source + orsopy.fileio.model_language + orsopy.fileio.orso + orsopy.fileio.reduction + orsopy.fileio.typing_backport + +Module contents +--------------- + +.. automodule:: orsopy.fileio + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/orsopy.fileio.typing_backport.rst b/docs/api/orsopy.fileio.typing_backport.rst new file mode 100644 index 00000000..8d593ee8 --- /dev/null +++ b/docs/api/orsopy.fileio.typing_backport.rst @@ -0,0 +1,7 @@ +orsopy.fileio.typing\_backport module +===================================== + +.. automodule:: orsopy.fileio.typing_backport + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/orsopy.orb2ort.rst b/docs/api/orsopy.orb2ort.rst new file mode 100644 index 00000000..e1081542 --- /dev/null +++ b/docs/api/orsopy.orb2ort.rst @@ -0,0 +1,7 @@ +orsopy.orb2ort module +===================== + +.. automodule:: orsopy.orb2ort + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/orsopy.ort2orb.rst b/docs/api/orsopy.ort2orb.rst new file mode 100644 index 00000000..48f83b1e --- /dev/null +++ b/docs/api/orsopy.ort2orb.rst @@ -0,0 +1,7 @@ +orsopy.ort2orb module +===================== + +.. automodule:: orsopy.ort2orb + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/orsopy.rst b/docs/api/orsopy.rst new file mode 100644 index 00000000..4a6c9a26 --- /dev/null +++ b/docs/api/orsopy.rst @@ -0,0 +1,29 @@ +orsopy package +============== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 1 + + orsopy.fileio + orsopy.slddb + orsopy.utils + +Submodules +---------- + +.. toctree:: + :maxdepth: 1 + + orsopy.orb2ort + orsopy.ort2orb + +Module contents +--------------- + +.. automodule:: orsopy + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/orsopy.slddb.comparators.rst b/docs/api/orsopy.slddb.comparators.rst new file mode 100644 index 00000000..251f5a4b --- /dev/null +++ b/docs/api/orsopy.slddb.comparators.rst @@ -0,0 +1,7 @@ +orsopy.slddb.comparators module +=============================== + +.. automodule:: orsopy.slddb.comparators + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/orsopy.slddb.constants.rst b/docs/api/orsopy.slddb.constants.rst new file mode 100644 index 00000000..b955ba56 --- /dev/null +++ b/docs/api/orsopy.slddb.constants.rst @@ -0,0 +1,7 @@ +orsopy.slddb.constants module +============================= + +.. automodule:: orsopy.slddb.constants + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/orsopy.slddb.converters.rst b/docs/api/orsopy.slddb.converters.rst new file mode 100644 index 00000000..81975743 --- /dev/null +++ b/docs/api/orsopy.slddb.converters.rst @@ -0,0 +1,7 @@ +orsopy.slddb.converters module +============================== + +.. automodule:: orsopy.slddb.converters + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/orsopy.slddb.database.rst b/docs/api/orsopy.slddb.database.rst new file mode 100644 index 00000000..0d8f17bf --- /dev/null +++ b/docs/api/orsopy.slddb.database.rst @@ -0,0 +1,7 @@ +orsopy.slddb.database module +============================ + +.. automodule:: orsopy.slddb.database + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/orsopy.slddb.dbconfig.rst b/docs/api/orsopy.slddb.dbconfig.rst new file mode 100644 index 00000000..fd2111ac --- /dev/null +++ b/docs/api/orsopy.slddb.dbconfig.rst @@ -0,0 +1,7 @@ +orsopy.slddb.dbconfig module +============================ + +.. automodule:: orsopy.slddb.dbconfig + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/orsopy.slddb.element_table.element.rst b/docs/api/orsopy.slddb.element_table.element.rst new file mode 100644 index 00000000..d1cf3e67 --- /dev/null +++ b/docs/api/orsopy.slddb.element_table.element.rst @@ -0,0 +1,7 @@ +orsopy.slddb.element\_table.element module +========================================== + +.. automodule:: orsopy.slddb.element_table.element + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/orsopy.slddb.element_table.masses.rst b/docs/api/orsopy.slddb.element_table.masses.rst new file mode 100644 index 00000000..6fda396d --- /dev/null +++ b/docs/api/orsopy.slddb.element_table.masses.rst @@ -0,0 +1,7 @@ +orsopy.slddb.element\_table.masses module +========================================= + +.. automodule:: orsopy.slddb.element_table.masses + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/orsopy.slddb.element_table.nabs_geant4.rst b/docs/api/orsopy.slddb.element_table.nabs_geant4.rst new file mode 100644 index 00000000..49c3c0da --- /dev/null +++ b/docs/api/orsopy.slddb.element_table.nabs_geant4.rst @@ -0,0 +1,7 @@ +orsopy.slddb.element\_table.nabs\_geant4 module +=============================================== + +.. automodule:: orsopy.slddb.element_table.nabs_geant4 + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/orsopy.slddb.element_table.nlengths.rst b/docs/api/orsopy.slddb.element_table.nlengths.rst new file mode 100644 index 00000000..ca8daf27 --- /dev/null +++ b/docs/api/orsopy.slddb.element_table.nlengths.rst @@ -0,0 +1,7 @@ +orsopy.slddb.element\_table.nlengths module +=========================================== + +.. automodule:: orsopy.slddb.element_table.nlengths + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/orsopy.slddb.element_table.nlengths_pt.rst b/docs/api/orsopy.slddb.element_table.nlengths_pt.rst new file mode 100644 index 00000000..ae484af6 --- /dev/null +++ b/docs/api/orsopy.slddb.element_table.nlengths_pt.rst @@ -0,0 +1,7 @@ +orsopy.slddb.element\_table.nlengths\_pt module +=============================================== + +.. automodule:: orsopy.slddb.element_table.nlengths_pt + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/orsopy.slddb.element_table.rst b/docs/api/orsopy.slddb.element_table.rst new file mode 100644 index 00000000..a309e15a --- /dev/null +++ b/docs/api/orsopy.slddb.element_table.rst @@ -0,0 +1,24 @@ +orsopy.slddb.element\_table package +=================================== + +Submodules +---------- + +.. toctree:: + :maxdepth: 1 + + orsopy.slddb.element_table.element + orsopy.slddb.element_table.masses + orsopy.slddb.element_table.nabs_geant4 + orsopy.slddb.element_table.nlengths + orsopy.slddb.element_table.nlengths_pt + orsopy.slddb.element_table.xray_henke + orsopy.slddb.element_table.xray_nist + +Module contents +--------------- + +.. automodule:: orsopy.slddb.element_table + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/orsopy.slddb.element_table.xray_henke.rst b/docs/api/orsopy.slddb.element_table.xray_henke.rst new file mode 100644 index 00000000..29ebf391 --- /dev/null +++ b/docs/api/orsopy.slddb.element_table.xray_henke.rst @@ -0,0 +1,7 @@ +orsopy.slddb.element\_table.xray\_henke module +============================================== + +.. automodule:: orsopy.slddb.element_table.xray_henke + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/orsopy.slddb.element_table.xray_nist.rst b/docs/api/orsopy.slddb.element_table.xray_nist.rst new file mode 100644 index 00000000..0eab6b02 --- /dev/null +++ b/docs/api/orsopy.slddb.element_table.xray_nist.rst @@ -0,0 +1,7 @@ +orsopy.slddb.element\_table.xray\_nist module +============================================= + +.. automodule:: orsopy.slddb.element_table.xray_nist + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/orsopy.slddb.importers.rst b/docs/api/orsopy.slddb.importers.rst new file mode 100644 index 00000000..c6de79b2 --- /dev/null +++ b/docs/api/orsopy.slddb.importers.rst @@ -0,0 +1,7 @@ +orsopy.slddb.importers module +============================= + +.. automodule:: orsopy.slddb.importers + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/orsopy.slddb.material.rst b/docs/api/orsopy.slddb.material.rst new file mode 100644 index 00000000..94f19752 --- /dev/null +++ b/docs/api/orsopy.slddb.material.rst @@ -0,0 +1,7 @@ +orsopy.slddb.material module +============================ + +.. automodule:: orsopy.slddb.material + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/orsopy.slddb.rst b/docs/api/orsopy.slddb.rst new file mode 100644 index 00000000..e2e0b103 --- /dev/null +++ b/docs/api/orsopy.slddb.rst @@ -0,0 +1,33 @@ +orsopy.slddb package +==================== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 1 + + orsopy.slddb.element_table + +Submodules +---------- + +.. toctree:: + :maxdepth: 1 + + orsopy.slddb.comparators + orsopy.slddb.constants + orsopy.slddb.converters + orsopy.slddb.database + orsopy.slddb.dbconfig + orsopy.slddb.importers + orsopy.slddb.material + orsopy.slddb.webapi + +Module contents +--------------- + +.. automodule:: orsopy.slddb + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/orsopy.slddb.webapi.rst b/docs/api/orsopy.slddb.webapi.rst new file mode 100644 index 00000000..65d13a20 --- /dev/null +++ b/docs/api/orsopy.slddb.webapi.rst @@ -0,0 +1,7 @@ +orsopy.slddb.webapi module +========================== + +.. automodule:: orsopy.slddb.webapi + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/orsopy.utils.chemical_formula.rst b/docs/api/orsopy.utils.chemical_formula.rst new file mode 100644 index 00000000..32039233 --- /dev/null +++ b/docs/api/orsopy.utils.chemical_formula.rst @@ -0,0 +1,7 @@ +orsopy.utils.chemical\_formula module +===================================== + +.. automodule:: orsopy.utils.chemical_formula + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/orsopy.utils.density_resolver.rst b/docs/api/orsopy.utils.density_resolver.rst new file mode 100644 index 00000000..b7f95886 --- /dev/null +++ b/docs/api/orsopy.utils.density_resolver.rst @@ -0,0 +1,7 @@ +orsopy.utils.density\_resolver module +===================================== + +.. automodule:: orsopy.utils.density_resolver + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/orsopy.utils.resolver_slddb.rst b/docs/api/orsopy.utils.resolver_slddb.rst new file mode 100644 index 00000000..f15585ef --- /dev/null +++ b/docs/api/orsopy.utils.resolver_slddb.rst @@ -0,0 +1,7 @@ +orsopy.utils.resolver\_slddb module +=================================== + +.. automodule:: orsopy.utils.resolver_slddb + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/orsopy.utils.rst b/docs/api/orsopy.utils.rst new file mode 100644 index 00000000..5b0a66e5 --- /dev/null +++ b/docs/api/orsopy.utils.rst @@ -0,0 +1,20 @@ +orsopy.utils package +==================== + +Submodules +---------- + +.. toctree:: + :maxdepth: 1 + + orsopy.utils.chemical_formula + orsopy.utils.density_resolver + orsopy.utils.resolver_slddb + +Module contents +--------------- + +.. automodule:: orsopy.utils + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/index.rst b/docs/index.rst index 1488af22..fd16083d 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -6,7 +6,7 @@ installation usage - modules + Reference contributing authors history diff --git a/docs/modules.rst b/docs/modules.rst deleted file mode 100644 index e3f38d55..00000000 --- a/docs/modules.rst +++ /dev/null @@ -1,16 +0,0 @@ -Modules -======= - -fileio ------- - -The role of the :py:mod:`fileio` module is to enable the creation of and parsing from ORSO reduced data files. -All public classes and functions in the :py:mod:`fileio` module are available directly from :py:mod:`fileio` without needing to specify a particular submodule. - -.. toctree:: - :maxdepth: 1 - - orsopy.fileio.base - orsopy.fileio.data_source - orsopy.fileio.reduction - orsopy.fileio.orso diff --git a/docs/orsopy.fileio.base.rst b/docs/orsopy.fileio.base.rst deleted file mode 100644 index a77bd581..00000000 --- a/docs/orsopy.fileio.base.rst +++ /dev/null @@ -1,7 +0,0 @@ -orsopy.fileio.base -================== - -.. automodule:: orsopy.fileio.base - :members: - :undoc-members: - :show-inheritance: \ No newline at end of file diff --git a/docs/orsopy.fileio.data_source.rst b/docs/orsopy.fileio.data_source.rst deleted file mode 100644 index 1ff3407d..00000000 --- a/docs/orsopy.fileio.data_source.rst +++ /dev/null @@ -1,7 +0,0 @@ -orsopy.fileio.data_source -========================= - -.. automodule:: orsopy.fileio.data_source - :members: - :undoc-members: - :show-inheritance: \ No newline at end of file diff --git a/docs/orsopy.fileio.orso.rst b/docs/orsopy.fileio.orso.rst deleted file mode 100644 index 60e3c10c..00000000 --- a/docs/orsopy.fileio.orso.rst +++ /dev/null @@ -1,7 +0,0 @@ -orsopy.fileio.orso -================== - -.. automodule:: orsopy.fileio.orso - :members: - :undoc-members: - :show-inheritance: \ No newline at end of file diff --git a/docs/orsopy.fileio.reduction.rst b/docs/orsopy.fileio.reduction.rst deleted file mode 100644 index 92308cee..00000000 --- a/docs/orsopy.fileio.reduction.rst +++ /dev/null @@ -1,7 +0,0 @@ -orsopy.fileio.reduction -======================= - -.. automodule:: orsopy.fileio.reduction - :members: - :undoc-members: - :show-inheritance: \ No newline at end of file diff --git a/orsopy/fileio/__init__.py b/orsopy/fileio/__init__.py index 0dfab7e2..fbf14bd2 100644 --- a/orsopy/fileio/__init__.py +++ b/orsopy/fileio/__init__.py @@ -1,5 +1,6 @@ """ -Implementation of the Orso class that defined the header. +The role of the :py:mod:`fileio` module is to enable the creation of and parsing from ORSO reduced data files. +All public classes and functions in the :py:mod:`fileio` module are available directly from :py:mod:`fileio` without needing to specify a particular submodule. """ from .base import (Column, ComplexValue, ErrorColumn, File, Header, Person, Value, ValueRange, ValueVector, diff --git a/requirements_dev.txt b/requirements_dev.txt index 9f648130..a1d5f7fa 100644 --- a/requirements_dev.txt +++ b/requirements_dev.txt @@ -3,6 +3,7 @@ wheel>=0.33.6 flake8>=3.7.8 coverage>=4.5.4 Sphinx>=1.8.5 +sphinx-rtd-theme twine>=1.14.0 numpy>=1.19.0 From 99640c7eeb5f723a6631eb27b72be2fd1cbd0042 Mon Sep 17 00:00:00 2001 From: alexhroom Date: Mon, 10 Feb 2025 12:44:50 +0000 Subject: [PATCH 2/3] reduced number of files --- docs/api/orsopy.fileio.base.rst | 7 -- docs/api/orsopy.fileio.data_source.rst | 7 -- docs/api/orsopy.fileio.model_language.rst | 7 -- docs/api/orsopy.fileio.orso.rst | 7 -- docs/api/orsopy.fileio.reduction.rst | 7 -- docs/api/orsopy.fileio.rst | 56 ++++++++++++--- docs/api/orsopy.fileio.typing_backport.rst | 7 -- docs/api/orsopy.orb2ort.rst | 7 -- docs/api/orsopy.ort2orb.rst | 7 -- docs/api/orsopy.rst | 18 +++-- docs/api/orsopy.slddb.comparators.rst | 7 -- docs/api/orsopy.slddb.constants.rst | 7 -- docs/api/orsopy.slddb.converters.rst | 7 -- docs/api/orsopy.slddb.database.rst | 7 -- docs/api/orsopy.slddb.dbconfig.rst | 7 -- .../orsopy.slddb.element_table.element.rst | 7 -- .../api/orsopy.slddb.element_table.masses.rst | 7 -- ...orsopy.slddb.element_table.nabs_geant4.rst | 7 -- .../orsopy.slddb.element_table.nlengths.rst | 7 -- ...orsopy.slddb.element_table.nlengths_pt.rst | 7 -- docs/api/orsopy.slddb.element_table.rst | 65 ++++++++++++++--- .../orsopy.slddb.element_table.xray_henke.rst | 7 -- .../orsopy.slddb.element_table.xray_nist.rst | 7 -- docs/api/orsopy.slddb.importers.rst | 7 -- docs/api/orsopy.slddb.material.rst | 7 -- docs/api/orsopy.slddb.rst | 72 ++++++++++++++++--- docs/api/orsopy.slddb.webapi.rst | 7 -- docs/api/orsopy.utils.chemical_formula.rst | 7 -- docs/api/orsopy.utils.density_resolver.rst | 7 -- docs/api/orsopy.utils.resolver_slddb.rst | 7 -- docs/api/orsopy.utils.rst | 27 +++++-- 31 files changed, 200 insertions(+), 220 deletions(-) delete mode 100644 docs/api/orsopy.fileio.base.rst delete mode 100644 docs/api/orsopy.fileio.data_source.rst delete mode 100644 docs/api/orsopy.fileio.model_language.rst delete mode 100644 docs/api/orsopy.fileio.orso.rst delete mode 100644 docs/api/orsopy.fileio.reduction.rst delete mode 100644 docs/api/orsopy.fileio.typing_backport.rst delete mode 100644 docs/api/orsopy.orb2ort.rst delete mode 100644 docs/api/orsopy.ort2orb.rst delete mode 100644 docs/api/orsopy.slddb.comparators.rst delete mode 100644 docs/api/orsopy.slddb.constants.rst delete mode 100644 docs/api/orsopy.slddb.converters.rst delete mode 100644 docs/api/orsopy.slddb.database.rst delete mode 100644 docs/api/orsopy.slddb.dbconfig.rst delete mode 100644 docs/api/orsopy.slddb.element_table.element.rst delete mode 100644 docs/api/orsopy.slddb.element_table.masses.rst delete mode 100644 docs/api/orsopy.slddb.element_table.nabs_geant4.rst delete mode 100644 docs/api/orsopy.slddb.element_table.nlengths.rst delete mode 100644 docs/api/orsopy.slddb.element_table.nlengths_pt.rst delete mode 100644 docs/api/orsopy.slddb.element_table.xray_henke.rst delete mode 100644 docs/api/orsopy.slddb.element_table.xray_nist.rst delete mode 100644 docs/api/orsopy.slddb.importers.rst delete mode 100644 docs/api/orsopy.slddb.material.rst delete mode 100644 docs/api/orsopy.slddb.webapi.rst delete mode 100644 docs/api/orsopy.utils.chemical_formula.rst delete mode 100644 docs/api/orsopy.utils.density_resolver.rst delete mode 100644 docs/api/orsopy.utils.resolver_slddb.rst diff --git a/docs/api/orsopy.fileio.base.rst b/docs/api/orsopy.fileio.base.rst deleted file mode 100644 index 1266cd39..00000000 --- a/docs/api/orsopy.fileio.base.rst +++ /dev/null @@ -1,7 +0,0 @@ -orsopy.fileio.base module -========================= - -.. automodule:: orsopy.fileio.base - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/api/orsopy.fileio.data_source.rst b/docs/api/orsopy.fileio.data_source.rst deleted file mode 100644 index 1972dcd0..00000000 --- a/docs/api/orsopy.fileio.data_source.rst +++ /dev/null @@ -1,7 +0,0 @@ -orsopy.fileio.data\_source module -================================= - -.. automodule:: orsopy.fileio.data_source - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/api/orsopy.fileio.model_language.rst b/docs/api/orsopy.fileio.model_language.rst deleted file mode 100644 index 7ce71cdb..00000000 --- a/docs/api/orsopy.fileio.model_language.rst +++ /dev/null @@ -1,7 +0,0 @@ -orsopy.fileio.model\_language module -==================================== - -.. automodule:: orsopy.fileio.model_language - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/api/orsopy.fileio.orso.rst b/docs/api/orsopy.fileio.orso.rst deleted file mode 100644 index b2dd1df0..00000000 --- a/docs/api/orsopy.fileio.orso.rst +++ /dev/null @@ -1,7 +0,0 @@ -orsopy.fileio.orso module -========================= - -.. automodule:: orsopy.fileio.orso - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/api/orsopy.fileio.reduction.rst b/docs/api/orsopy.fileio.reduction.rst deleted file mode 100644 index 2ab1581a..00000000 --- a/docs/api/orsopy.fileio.reduction.rst +++ /dev/null @@ -1,7 +0,0 @@ -orsopy.fileio.reduction module -============================== - -.. automodule:: orsopy.fileio.reduction - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/api/orsopy.fileio.rst b/docs/api/orsopy.fileio.rst index 6f42bc7c..cdfcef45 100644 --- a/docs/api/orsopy.fileio.rst +++ b/docs/api/orsopy.fileio.rst @@ -4,15 +4,53 @@ orsopy.fileio package Submodules ---------- -.. toctree:: - :maxdepth: 1 - - orsopy.fileio.base - orsopy.fileio.data_source - orsopy.fileio.model_language - orsopy.fileio.orso - orsopy.fileio.reduction - orsopy.fileio.typing_backport +orsopy.fileio.base module +------------------------- + +.. automodule:: orsopy.fileio.base + :members: + :undoc-members: + :show-inheritance: + +orsopy.fileio.data\_source module +--------------------------------- + +.. automodule:: orsopy.fileio.data_source + :members: + :undoc-members: + :show-inheritance: + +orsopy.fileio.model\_language module +------------------------------------ + +.. automodule:: orsopy.fileio.model_language + :members: + :undoc-members: + :show-inheritance: + +orsopy.fileio.orso module +------------------------- + +.. automodule:: orsopy.fileio.orso + :members: + :undoc-members: + :show-inheritance: + +orsopy.fileio.reduction module +------------------------------ + +.. automodule:: orsopy.fileio.reduction + :members: + :undoc-members: + :show-inheritance: + +orsopy.fileio.typing\_backport module +------------------------------------- + +.. automodule:: orsopy.fileio.typing_backport + :members: + :undoc-members: + :show-inheritance: Module contents --------------- diff --git a/docs/api/orsopy.fileio.typing_backport.rst b/docs/api/orsopy.fileio.typing_backport.rst deleted file mode 100644 index 8d593ee8..00000000 --- a/docs/api/orsopy.fileio.typing_backport.rst +++ /dev/null @@ -1,7 +0,0 @@ -orsopy.fileio.typing\_backport module -===================================== - -.. automodule:: orsopy.fileio.typing_backport - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/api/orsopy.orb2ort.rst b/docs/api/orsopy.orb2ort.rst deleted file mode 100644 index e1081542..00000000 --- a/docs/api/orsopy.orb2ort.rst +++ /dev/null @@ -1,7 +0,0 @@ -orsopy.orb2ort module -===================== - -.. automodule:: orsopy.orb2ort - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/api/orsopy.ort2orb.rst b/docs/api/orsopy.ort2orb.rst deleted file mode 100644 index 48f83b1e..00000000 --- a/docs/api/orsopy.ort2orb.rst +++ /dev/null @@ -1,7 +0,0 @@ -orsopy.ort2orb module -===================== - -.. automodule:: orsopy.ort2orb - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/api/orsopy.rst b/docs/api/orsopy.rst index 4a6c9a26..a0dfb676 100644 --- a/docs/api/orsopy.rst +++ b/docs/api/orsopy.rst @@ -14,11 +14,21 @@ Subpackages Submodules ---------- -.. toctree:: - :maxdepth: 1 +orsopy.orb2ort module +--------------------- + +.. automodule:: orsopy.orb2ort + :members: + :undoc-members: + :show-inheritance: + +orsopy.ort2orb module +--------------------- - orsopy.orb2ort - orsopy.ort2orb +.. automodule:: orsopy.ort2orb + :members: + :undoc-members: + :show-inheritance: Module contents --------------- diff --git a/docs/api/orsopy.slddb.comparators.rst b/docs/api/orsopy.slddb.comparators.rst deleted file mode 100644 index 251f5a4b..00000000 --- a/docs/api/orsopy.slddb.comparators.rst +++ /dev/null @@ -1,7 +0,0 @@ -orsopy.slddb.comparators module -=============================== - -.. automodule:: orsopy.slddb.comparators - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/api/orsopy.slddb.constants.rst b/docs/api/orsopy.slddb.constants.rst deleted file mode 100644 index b955ba56..00000000 --- a/docs/api/orsopy.slddb.constants.rst +++ /dev/null @@ -1,7 +0,0 @@ -orsopy.slddb.constants module -============================= - -.. automodule:: orsopy.slddb.constants - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/api/orsopy.slddb.converters.rst b/docs/api/orsopy.slddb.converters.rst deleted file mode 100644 index 81975743..00000000 --- a/docs/api/orsopy.slddb.converters.rst +++ /dev/null @@ -1,7 +0,0 @@ -orsopy.slddb.converters module -============================== - -.. automodule:: orsopy.slddb.converters - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/api/orsopy.slddb.database.rst b/docs/api/orsopy.slddb.database.rst deleted file mode 100644 index 0d8f17bf..00000000 --- a/docs/api/orsopy.slddb.database.rst +++ /dev/null @@ -1,7 +0,0 @@ -orsopy.slddb.database module -============================ - -.. automodule:: orsopy.slddb.database - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/api/orsopy.slddb.dbconfig.rst b/docs/api/orsopy.slddb.dbconfig.rst deleted file mode 100644 index fd2111ac..00000000 --- a/docs/api/orsopy.slddb.dbconfig.rst +++ /dev/null @@ -1,7 +0,0 @@ -orsopy.slddb.dbconfig module -============================ - -.. automodule:: orsopy.slddb.dbconfig - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/api/orsopy.slddb.element_table.element.rst b/docs/api/orsopy.slddb.element_table.element.rst deleted file mode 100644 index d1cf3e67..00000000 --- a/docs/api/orsopy.slddb.element_table.element.rst +++ /dev/null @@ -1,7 +0,0 @@ -orsopy.slddb.element\_table.element module -========================================== - -.. automodule:: orsopy.slddb.element_table.element - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/api/orsopy.slddb.element_table.masses.rst b/docs/api/orsopy.slddb.element_table.masses.rst deleted file mode 100644 index 6fda396d..00000000 --- a/docs/api/orsopy.slddb.element_table.masses.rst +++ /dev/null @@ -1,7 +0,0 @@ -orsopy.slddb.element\_table.masses module -========================================= - -.. automodule:: orsopy.slddb.element_table.masses - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/api/orsopy.slddb.element_table.nabs_geant4.rst b/docs/api/orsopy.slddb.element_table.nabs_geant4.rst deleted file mode 100644 index 49c3c0da..00000000 --- a/docs/api/orsopy.slddb.element_table.nabs_geant4.rst +++ /dev/null @@ -1,7 +0,0 @@ -orsopy.slddb.element\_table.nabs\_geant4 module -=============================================== - -.. automodule:: orsopy.slddb.element_table.nabs_geant4 - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/api/orsopy.slddb.element_table.nlengths.rst b/docs/api/orsopy.slddb.element_table.nlengths.rst deleted file mode 100644 index ca8daf27..00000000 --- a/docs/api/orsopy.slddb.element_table.nlengths.rst +++ /dev/null @@ -1,7 +0,0 @@ -orsopy.slddb.element\_table.nlengths module -=========================================== - -.. automodule:: orsopy.slddb.element_table.nlengths - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/api/orsopy.slddb.element_table.nlengths_pt.rst b/docs/api/orsopy.slddb.element_table.nlengths_pt.rst deleted file mode 100644 index ae484af6..00000000 --- a/docs/api/orsopy.slddb.element_table.nlengths_pt.rst +++ /dev/null @@ -1,7 +0,0 @@ -orsopy.slddb.element\_table.nlengths\_pt module -=============================================== - -.. automodule:: orsopy.slddb.element_table.nlengths_pt - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/api/orsopy.slddb.element_table.rst b/docs/api/orsopy.slddb.element_table.rst index a309e15a..59cd29a5 100644 --- a/docs/api/orsopy.slddb.element_table.rst +++ b/docs/api/orsopy.slddb.element_table.rst @@ -4,16 +4,61 @@ orsopy.slddb.element\_table package Submodules ---------- -.. toctree:: - :maxdepth: 1 - - orsopy.slddb.element_table.element - orsopy.slddb.element_table.masses - orsopy.slddb.element_table.nabs_geant4 - orsopy.slddb.element_table.nlengths - orsopy.slddb.element_table.nlengths_pt - orsopy.slddb.element_table.xray_henke - orsopy.slddb.element_table.xray_nist +orsopy.slddb.element\_table.element module +------------------------------------------ + +.. automodule:: orsopy.slddb.element_table.element + :members: + :undoc-members: + :show-inheritance: + +orsopy.slddb.element\_table.masses module +----------------------------------------- + +.. automodule:: orsopy.slddb.element_table.masses + :members: + :undoc-members: + :show-inheritance: + +orsopy.slddb.element\_table.nabs\_geant4 module +----------------------------------------------- + +.. automodule:: orsopy.slddb.element_table.nabs_geant4 + :members: + :undoc-members: + :show-inheritance: + +orsopy.slddb.element\_table.nlengths module +------------------------------------------- + +.. automodule:: orsopy.slddb.element_table.nlengths + :members: + :undoc-members: + :show-inheritance: + +orsopy.slddb.element\_table.nlengths\_pt module +----------------------------------------------- + +.. automodule:: orsopy.slddb.element_table.nlengths_pt + :members: + :undoc-members: + :show-inheritance: + +orsopy.slddb.element\_table.xray\_henke module +---------------------------------------------- + +.. automodule:: orsopy.slddb.element_table.xray_henke + :members: + :undoc-members: + :show-inheritance: + +orsopy.slddb.element\_table.xray\_nist module +--------------------------------------------- + +.. automodule:: orsopy.slddb.element_table.xray_nist + :members: + :undoc-members: + :show-inheritance: Module contents --------------- diff --git a/docs/api/orsopy.slddb.element_table.xray_henke.rst b/docs/api/orsopy.slddb.element_table.xray_henke.rst deleted file mode 100644 index 29ebf391..00000000 --- a/docs/api/orsopy.slddb.element_table.xray_henke.rst +++ /dev/null @@ -1,7 +0,0 @@ -orsopy.slddb.element\_table.xray\_henke module -============================================== - -.. automodule:: orsopy.slddb.element_table.xray_henke - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/api/orsopy.slddb.element_table.xray_nist.rst b/docs/api/orsopy.slddb.element_table.xray_nist.rst deleted file mode 100644 index 0eab6b02..00000000 --- a/docs/api/orsopy.slddb.element_table.xray_nist.rst +++ /dev/null @@ -1,7 +0,0 @@ -orsopy.slddb.element\_table.xray\_nist module -============================================= - -.. automodule:: orsopy.slddb.element_table.xray_nist - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/api/orsopy.slddb.importers.rst b/docs/api/orsopy.slddb.importers.rst deleted file mode 100644 index c6de79b2..00000000 --- a/docs/api/orsopy.slddb.importers.rst +++ /dev/null @@ -1,7 +0,0 @@ -orsopy.slddb.importers module -============================= - -.. automodule:: orsopy.slddb.importers - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/api/orsopy.slddb.material.rst b/docs/api/orsopy.slddb.material.rst deleted file mode 100644 index 94f19752..00000000 --- a/docs/api/orsopy.slddb.material.rst +++ /dev/null @@ -1,7 +0,0 @@ -orsopy.slddb.material module -============================ - -.. automodule:: orsopy.slddb.material - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/api/orsopy.slddb.rst b/docs/api/orsopy.slddb.rst index e2e0b103..5b168264 100644 --- a/docs/api/orsopy.slddb.rst +++ b/docs/api/orsopy.slddb.rst @@ -12,17 +12,69 @@ Subpackages Submodules ---------- -.. toctree:: - :maxdepth: 1 +orsopy.slddb.comparators module +------------------------------- + +.. automodule:: orsopy.slddb.comparators + :members: + :undoc-members: + :show-inheritance: + +orsopy.slddb.constants module +----------------------------- + +.. automodule:: orsopy.slddb.constants + :members: + :undoc-members: + :show-inheritance: + +orsopy.slddb.converters module +------------------------------ + +.. automodule:: orsopy.slddb.converters + :members: + :undoc-members: + :show-inheritance: + +orsopy.slddb.database module +---------------------------- + +.. automodule:: orsopy.slddb.database + :members: + :undoc-members: + :show-inheritance: + +orsopy.slddb.dbconfig module +---------------------------- + +.. automodule:: orsopy.slddb.dbconfig + :members: + :undoc-members: + :show-inheritance: + +orsopy.slddb.importers module +----------------------------- + +.. automodule:: orsopy.slddb.importers + :members: + :undoc-members: + :show-inheritance: + +orsopy.slddb.material module +---------------------------- + +.. automodule:: orsopy.slddb.material + :members: + :undoc-members: + :show-inheritance: + +orsopy.slddb.webapi module +-------------------------- - orsopy.slddb.comparators - orsopy.slddb.constants - orsopy.slddb.converters - orsopy.slddb.database - orsopy.slddb.dbconfig - orsopy.slddb.importers - orsopy.slddb.material - orsopy.slddb.webapi +.. automodule:: orsopy.slddb.webapi + :members: + :undoc-members: + :show-inheritance: Module contents --------------- diff --git a/docs/api/orsopy.slddb.webapi.rst b/docs/api/orsopy.slddb.webapi.rst deleted file mode 100644 index 65d13a20..00000000 --- a/docs/api/orsopy.slddb.webapi.rst +++ /dev/null @@ -1,7 +0,0 @@ -orsopy.slddb.webapi module -========================== - -.. automodule:: orsopy.slddb.webapi - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/api/orsopy.utils.chemical_formula.rst b/docs/api/orsopy.utils.chemical_formula.rst deleted file mode 100644 index 32039233..00000000 --- a/docs/api/orsopy.utils.chemical_formula.rst +++ /dev/null @@ -1,7 +0,0 @@ -orsopy.utils.chemical\_formula module -===================================== - -.. automodule:: orsopy.utils.chemical_formula - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/api/orsopy.utils.density_resolver.rst b/docs/api/orsopy.utils.density_resolver.rst deleted file mode 100644 index b7f95886..00000000 --- a/docs/api/orsopy.utils.density_resolver.rst +++ /dev/null @@ -1,7 +0,0 @@ -orsopy.utils.density\_resolver module -===================================== - -.. automodule:: orsopy.utils.density_resolver - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/api/orsopy.utils.resolver_slddb.rst b/docs/api/orsopy.utils.resolver_slddb.rst deleted file mode 100644 index f15585ef..00000000 --- a/docs/api/orsopy.utils.resolver_slddb.rst +++ /dev/null @@ -1,7 +0,0 @@ -orsopy.utils.resolver\_slddb module -=================================== - -.. automodule:: orsopy.utils.resolver_slddb - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/api/orsopy.utils.rst b/docs/api/orsopy.utils.rst index 5b0a66e5..341f9a8b 100644 --- a/docs/api/orsopy.utils.rst +++ b/docs/api/orsopy.utils.rst @@ -4,12 +4,29 @@ orsopy.utils package Submodules ---------- -.. toctree:: - :maxdepth: 1 +orsopy.utils.chemical\_formula module +------------------------------------- - orsopy.utils.chemical_formula - orsopy.utils.density_resolver - orsopy.utils.resolver_slddb +.. automodule:: orsopy.utils.chemical_formula + :members: + :undoc-members: + :show-inheritance: + +orsopy.utils.density\_resolver module +------------------------------------- + +.. automodule:: orsopy.utils.density_resolver + :members: + :undoc-members: + :show-inheritance: + +orsopy.utils.resolver\_slddb module +----------------------------------- + +.. automodule:: orsopy.utils.resolver_slddb + :members: + :undoc-members: + :show-inheritance: Module contents --------------- From d52eaf8f11592c7d2df87d5a7815bed74d05ac50 Mon Sep 17 00:00:00 2001 From: alexhroom Date: Fri, 21 Feb 2025 11:28:02 +0000 Subject: [PATCH 3/3] moved module to start and added backlink to file format --- docs/api/orsopy.fileio.rst | 13 +++++-------- docs/api/orsopy.rst | 13 +++++-------- docs/api/orsopy.slddb.element_table.rst | 13 +++++-------- docs/api/orsopy.slddb.rst | 13 +++++-------- docs/api/orsopy.utils.rst | 13 +++++-------- orsopy/fileio/__init__.py | 2 ++ 6 files changed, 27 insertions(+), 40 deletions(-) diff --git a/docs/api/orsopy.fileio.rst b/docs/api/orsopy.fileio.rst index cdfcef45..872ec871 100644 --- a/docs/api/orsopy.fileio.rst +++ b/docs/api/orsopy.fileio.rst @@ -1,6 +1,11 @@ orsopy.fileio package ===================== +.. automodule:: orsopy.fileio + :members: + :undoc-members: + :show-inheritance: + Submodules ---------- @@ -51,11 +56,3 @@ orsopy.fileio.typing\_backport module :members: :undoc-members: :show-inheritance: - -Module contents ---------------- - -.. automodule:: orsopy.fileio - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/api/orsopy.rst b/docs/api/orsopy.rst index a0dfb676..b93ec61f 100644 --- a/docs/api/orsopy.rst +++ b/docs/api/orsopy.rst @@ -1,6 +1,11 @@ orsopy package ============== +.. automodule:: orsopy + :members: + :undoc-members: + :show-inheritance: + Subpackages ----------- @@ -29,11 +34,3 @@ orsopy.ort2orb module :members: :undoc-members: :show-inheritance: - -Module contents ---------------- - -.. automodule:: orsopy - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/api/orsopy.slddb.element_table.rst b/docs/api/orsopy.slddb.element_table.rst index 59cd29a5..9533d2a4 100644 --- a/docs/api/orsopy.slddb.element_table.rst +++ b/docs/api/orsopy.slddb.element_table.rst @@ -1,6 +1,11 @@ orsopy.slddb.element\_table package =================================== +.. automodule:: orsopy.slddb.element_table + :members: + :undoc-members: + :show-inheritance: + Submodules ---------- @@ -59,11 +64,3 @@ orsopy.slddb.element\_table.xray\_nist module :members: :undoc-members: :show-inheritance: - -Module contents ---------------- - -.. automodule:: orsopy.slddb.element_table - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/api/orsopy.slddb.rst b/docs/api/orsopy.slddb.rst index 5b168264..26af43f2 100644 --- a/docs/api/orsopy.slddb.rst +++ b/docs/api/orsopy.slddb.rst @@ -1,6 +1,11 @@ orsopy.slddb package ==================== +.. automodule:: orsopy.slddb + :members: + :undoc-members: + :show-inheritance: + Subpackages ----------- @@ -75,11 +80,3 @@ orsopy.slddb.webapi module :members: :undoc-members: :show-inheritance: - -Module contents ---------------- - -.. automodule:: orsopy.slddb - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/api/orsopy.utils.rst b/docs/api/orsopy.utils.rst index 341f9a8b..29ba0817 100644 --- a/docs/api/orsopy.utils.rst +++ b/docs/api/orsopy.utils.rst @@ -1,6 +1,11 @@ orsopy.utils package ==================== +.. automodule:: orsopy.utils + :members: + :undoc-members: + :show-inheritance: + Submodules ---------- @@ -27,11 +32,3 @@ orsopy.utils.resolver\_slddb module :members: :undoc-members: :show-inheritance: - -Module contents ---------------- - -.. automodule:: orsopy.utils - :members: - :undoc-members: - :show-inheritance: diff --git a/orsopy/fileio/__init__.py b/orsopy/fileio/__init__.py index fbf14bd2..20f6813a 100644 --- a/orsopy/fileio/__init__.py +++ b/orsopy/fileio/__init__.py @@ -1,6 +1,8 @@ """ The role of the :py:mod:`fileio` module is to enable the creation of and parsing from ORSO reduced data files. All public classes and functions in the :py:mod:`fileio` module are available directly from :py:mod:`fileio` without needing to specify a particular submodule. + +The ORSO file format specification is available `here `_. """ from .base import (Column, ComplexValue, ErrorColumn, File, Header, Person, Value, ValueRange, ValueVector,