Skip to content

Commit fd64a8a

Browse files
committed
Rearrange docs, expose models
1 parent 8f0df4f commit fd64a8a

4 files changed

Lines changed: 26 additions & 6 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: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,23 @@
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

@@ -15,23 +27,23 @@
1527
:show-inheritance:
1628

1729
:mod:`Create Services`
18-
---------------------
30+
-----------------------
1931

2032
.. automodule:: odm2api.ODM2.services.createService
2133
:members:
2234
:undoc-members:
2335
:show-inheritance:
2436

2537
:mod:`Delete Services`
26-
---------------------
38+
-----------------------
2739

2840
.. automodule:: odm2api.ODM2.services.deleteService
2941
:members:
3042
:undoc-members:
3143
:show-inheritance:
3244

3345
:mod:`Update Services`
34-
---------------------
46+
-----------------------
3547

3648
.. automodule:: odm2api.ODM2.services.updateService
3749
:members:

0 commit comments

Comments
 (0)