Skip to content

Expose services #108

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
emiliom merged 3 commits into from
Oct 2, 2017
Merged

Expose services #108

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
384fde4
Expose other module services
lsetiawan Oct 2, 2017
8f0df4f
Fix reST syntax
lsetiawan Oct 2, 2017
fd64a8a
Rearrange docs, expose models
lsetiawan Oct 2, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ A Python-based application programmer's interface for the `Observations Data Mod

installing
modules
models
credits

Indices and tables
Expand Down
2 changes: 1 addition & 1 deletion docs/source/installing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Installation
------------
============

The easiest and most reliable way to install the ODM2 Python API
(``odm2api``) is using the `Conda package management
Expand Down
7 changes: 7 additions & 0 deletions docs/source/models.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
ODM2 Models
===========

.. automodule:: odm2api.ODM2.models
:members:
:undoc-members:
:show-inheritance:
40 changes: 38 additions & 2 deletions docs/source/modules.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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: