diff --git a/docs/source/index.rst b/docs/source/index.rst index 554e7ae..12f67b6 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -9,6 +9,7 @@ A Python-based application programmer's interface for the `Observations Data Mod installing modules + models credits Indices and tables diff --git a/docs/source/installing.rst b/docs/source/installing.rst index dc9b164..a135c24 100644 --- a/docs/source/installing.rst +++ b/docs/source/installing.rst @@ -1,5 +1,5 @@ Installation ------------- +============ The easiest and most reliable way to install the ODM2 Python API (``odm2api``) is using the `Conda package management diff --git a/docs/source/models.rst b/docs/source/models.rst new file mode 100644 index 0000000..2749f58 --- /dev/null +++ b/docs/source/models.rst @@ -0,0 +1,7 @@ +ODM2 Models +=========== + +.. automodule:: odm2api.ODM2.models + :members: + :undoc-members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/modules.rst b/docs/source/modules.rst index 049cd0c..c3aa99d 100644 --- a/docs/source/modules.rst +++ b/docs/source/modules.rst @@ -1,15 +1,51 @@ -:mod:`ODMconnection` ---------------------- +Developer Interface +=================== + +.. module:: odm2api + +This part of the documentation covers all the interfaces of ODM2PythonAPI. + +:mod:`Database Connection` +--------------------------- .. automodule:: odm2api.ODMconnection :members: :undoc-members: :show-inheritance: +.. automodule:: odm2api.base + :members: + :undoc-members: + :show-inheritance: + :mod:`Read Services` --------------------- .. automodule:: odm2api.ODM2.services.readService + :members: + :undoc-members: + :show-inheritance: + +:mod:`Create Services` +----------------------- + +.. automodule:: odm2api.ODM2.services.createService + :members: + :undoc-members: + :show-inheritance: + +:mod:`Delete Services` +----------------------- + +.. automodule:: odm2api.ODM2.services.deleteService + :members: + :undoc-members: + :show-inheritance: + +:mod:`Update Services` +----------------------- + +.. automodule:: odm2api.ODM2.services.updateService :members: :undoc-members: :show-inheritance: \ No newline at end of file