Skip to content

Commit 8d70f50

Browse files
committed
Updated content and structure of Sphinx docs
1 parent f556f66 commit 8d70f50

File tree

5 files changed

+47
-14
lines changed

5 files changed

+47
-14
lines changed

docs/source/contribute.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
Contributing
22
============================
33

4-
You can help with ODM2 Python API by contributing code, helping with the documentation, and engaging the team via GitHub issues (questions, solutions, etc).
4+
You can help with ODM2 Python API by contributing code, helping with the documentation, or engaging the team via `GitHub issues <https://github.com/ODM2/ODM2PythonAPI/issues>`_ (questions, solutions, etc).
55

66

7-
Installing the development version from the development branch on github
8-
----------------------------------
7+
Install the development version from GitHub
8+
--------------------------------------------
99

10-
Note: We follow the `Gitflow workflow <https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow>`__ for development.
10+
The latest development version is found in the ``development`` branch of the github repository. We follow the `Gitflow workflow <https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow>`__ for development.
1111

1212
1. Download both ``requirements.txt`` and ``requirements-dev.txt``.
1313

docs/source/getstarted.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@ Get Started
22
============
33

44

5-
Install the latest release as a conda package from conda-forge
6-
----------------------------------------------
5+
Install the latest release from a conda package
6+
------------------------------------------------
77

88
conda
99
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

docs/source/index.rst

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,24 @@
1-
ODM2 Python API
2-
===============
1+
ODM2 Python API (odm2api)
2+
=========================
33

4-
A Python-based application programmer's interface for the `Observations Data Model 2 (ODM2) <http://www.odm2.org>`__.
4+
A Python-based application programmer's interface for the `Observations Data Model 2 (ODM2) <http://www.odm2.org>`__. Development of ``odm2api`` is done at `<https://github.com/ODM2/ODM2PythonAPI/>`_.
55

66
.. toctree::
77
:maxdepth: 2
88
:caption: Contents:
99

1010
getstarted
11-
modules
1211
odm2models
12+
modules
1313
contribute
1414
credits
1515

16-
Indices and tables
17-
==================
16+
Indices
17+
=======
1818

1919
.. toctree::
2020
:maxdepth: 2
2121

22-
models
23-
2422
* :ref:`genindex`
2523
* :ref:`modindex`
2624
* :ref:`search`

docs/source/models.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,9 @@ The following are entities in the `ODM2 Core Schema <http://odm2.github.io/ODM2/
1212

1313
.. autosummary::
1414

15+
odm2api.models.ActionBy
1516
odm2api.models.Actions
17+
odm2api.models.Affiliations
1618
odm2api.models.DataSets
1719
odm2api.models.FeatureActions
1820
odm2api.models.Methods

docs/source/odm2models.rst

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,39 @@
11
ODM2 Models
22
===========
33

4+
ODM2 is organized with a "core" schema and multiple "extension" schemas that
5+
extend the functionality of the core. The following sections cover some overarching concepts
6+
for ODM2 and then focus on specific entities within the ODM2 Core schema and ODM2's extension schemas.
7+
8+
ODM2Core Entities
9+
------------------
10+
11+
The following are entities in the `ODM2 Core Schema <http://odm2.github.io/ODM2/schemas/ODM2_Current/diagrams/ODM2Core.html>`__:
12+
13+
.. autosummary::
14+
15+
odm2api.models.ActionBy
16+
odm2api.models.Actions
17+
odm2api.models.Affiliations
18+
odm2api.models.DataSets
19+
odm2api.models.FeatureActions
20+
odm2api.models.Methods
21+
odm2api.models.Organizations
22+
odm2api.models.People
23+
odm2api.models.ProcessingLevels
24+
odm2api.models.RelatedActions
25+
odm2api.models.Results
26+
odm2api.models.SamplingFeatures
27+
odm2api.models.TaxonomicClassifiers
28+
odm2api.models.Units
29+
odm2api.models.Variables
30+
31+
32+
All ODM2 models
33+
----------------
34+
35+
API descriptions for `all ODM2 models (entities) <http://odm2.github.io/ODM2/schemas/ODM2_Current/schemas/index.html>`_.
36+
437
.. automodule:: odm2api.models
538
:members:
639
:undoc-members:

0 commit comments

Comments
 (0)