From 384fde4d7488153ba1850f8f7f6ce5ab033ccce2 Mon Sep 17 00:00:00 2001 From: lsetiawan Date: Mon, 2 Oct 2017 13:20:44 -0700 Subject: [PATCH 1/3] Expose other module services --- docs/source/modules.rst | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/docs/source/modules.rst b/docs/source/modules.rst index 049cd0c..e650cf5 100644 --- a/docs/source/modules.rst +++ b/docs/source/modules.rst @@ -10,6 +10,30 @@ --------------------- .. 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 From 8f0df4f81191f66bd6f3dbe855009aaeb4e9fc8c Mon Sep 17 00:00:00 2001 From: lsetiawan Date: Mon, 2 Oct 2017 13:22:42 -0700 Subject: [PATCH 2/3] Fix reST syntax --- docs/source/modules.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/source/modules.rst b/docs/source/modules.rst index e650cf5..b461a1c 100644 --- a/docs/source/modules.rst +++ b/docs/source/modules.rst @@ -14,7 +14,7 @@ :undoc-members: :show-inheritance: -mod:`Create Services` +:mod:`Create Services` --------------------- .. automodule:: odm2api.ODM2.services.createService @@ -22,7 +22,7 @@ mod:`Create Services` :undoc-members: :show-inheritance: -mod:`Delete Services` +:mod:`Delete Services` --------------------- .. automodule:: odm2api.ODM2.services.deleteService @@ -30,7 +30,7 @@ mod:`Delete Services` :undoc-members: :show-inheritance: -mod:`Update Services` +:mod:`Update Services` --------------------- .. automodule:: odm2api.ODM2.services.updateService From fd64a8a86a782f52747ec7eba1079e9c525b3966 Mon Sep 17 00:00:00 2001 From: lsetiawan Date: Mon, 2 Oct 2017 14:13:09 -0700 Subject: [PATCH 3/3] Rearrange docs, expose models --- docs/source/index.rst | 1 + docs/source/installing.rst | 2 +- docs/source/models.rst | 7 +++++++ docs/source/modules.rst | 22 +++++++++++++++++----- 4 files changed, 26 insertions(+), 6 deletions(-) create mode 100644 docs/source/models.rst 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 b461a1c..c3aa99d 100644 --- a/docs/source/modules.rst +++ b/docs/source/modules.rst @@ -1,11 +1,23 @@ -: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` --------------------- @@ -15,7 +27,7 @@ :show-inheritance: :mod:`Create Services` ---------------------- +----------------------- .. automodule:: odm2api.ODM2.services.createService :members: @@ -23,7 +35,7 @@ :show-inheritance: :mod:`Delete Services` ---------------------- +----------------------- .. automodule:: odm2api.ODM2.services.deleteService :members: @@ -31,7 +43,7 @@ :show-inheritance: :mod:`Update Services` ---------------------- +----------------------- .. automodule:: odm2api.ODM2.services.updateService :members: