Skip to content

Commit bc75796

Browse files
authored
Merge pull request #108 from lsetiawan/expose_services
Expose services
2 parents f6e5859 + fd64a8a commit bc75796

4 files changed

Lines changed: 47 additions & 3 deletions

File tree

docs/source/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ A Python-based application programmer's interface for the `Observations Data Mod
99

1010
installing
1111
modules
12+
models
1213
credits
1314

1415
Indices and tables

docs/source/installing.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
Installation
2-
------------
2+
============
33

44
The easiest and most reliable way to install the ODM2 Python API
55
(``odm2api``) is using the `Conda package management

docs/source/models.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
ODM2 Models
2+
===========
3+
4+
.. automodule:: odm2api.ODM2.models
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

docs/source/modules.rst

Lines changed: 38 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,51 @@
1-
:mod:`ODMconnection`
2-
---------------------
1+
Developer Interface
2+
===================
3+
4+
.. module:: odm2api
5+
6+
This part of the documentation covers all the interfaces of ODM2PythonAPI.
7+
8+
:mod:`Database Connection`
9+
---------------------------
310

411
.. automodule:: odm2api.ODMconnection
512
:members:
613
:undoc-members:
714
:show-inheritance:
815

16+
.. automodule:: odm2api.base
17+
:members:
18+
:undoc-members:
19+
:show-inheritance:
20+
921
:mod:`Read Services`
1022
---------------------
1123

1224
.. automodule:: odm2api.ODM2.services.readService
25+
:members:
26+
:undoc-members:
27+
:show-inheritance:
28+
29+
:mod:`Create Services`
30+
-----------------------
31+
32+
.. automodule:: odm2api.ODM2.services.createService
33+
:members:
34+
:undoc-members:
35+
:show-inheritance:
36+
37+
:mod:`Delete Services`
38+
-----------------------
39+
40+
.. automodule:: odm2api.ODM2.services.deleteService
41+
:members:
42+
:undoc-members:
43+
:show-inheritance:
44+
45+
:mod:`Update Services`
46+
-----------------------
47+
48+
.. automodule:: odm2api.ODM2.services.updateService
1349
:members:
1450
:undoc-members:
1551
:show-inheritance:

0 commit comments

Comments
 (0)