From 24887420a5215ce1745bfea7eeb5a5bb81faa457 Mon Sep 17 00:00:00 2001 From: Adam Paquette <acpaquette@usgs.gov> Date: Mon, 28 Jan 2019 18:00:28 -0700 Subject: [PATCH] Updated doc files to include all modules and functions --- docs/source/index.rst | 6 ++---- docs/source/library/ale/index.rst | 3 --- docs/source/library/capi/capi.rst | 4 ++-- docs/source/library/capi/index.rst | 2 -- docs/source/library/index.rst | 3 ++- docs/source/library/python/base.rst | 5 +++-- docs/source/library/python/cassini_driver.rst | 1 + docs/source/library/python/index.rst | 5 ++--- docs/source/library/python/lro_driver.rst | 1 + docs/source/library/python/mdis_driver.rst | 1 + docs/source/library/python/mro_driver.rst | 1 + 11 files changed, 15 insertions(+), 17 deletions(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index 4404a57..8e2ad1c 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -6,8 +6,6 @@ Ephemeris Abstraction Library :Date: |today| .. toctree:: - :maxdepth: 2 + :maxdepth: 3 - library/capi/index - library/python/index - library/ale/index + library/index diff --git a/docs/source/library/ale/index.rst b/docs/source/library/ale/index.rst index f830013..e348dca 100644 --- a/docs/source/library/ale/index.rst +++ b/docs/source/library/ale/index.rst @@ -1,5 +1,2 @@ ALE C API ========= - -.. doxygenfile:: ale.cpp - :project: ale \ No newline at end of file diff --git a/docs/source/library/capi/capi.rst b/docs/source/library/capi/capi.rst index 812e8cb..243294f 100644 --- a/docs/source/library/capi/capi.rst +++ b/docs/source/library/capi/capi.rst @@ -1,9 +1,9 @@ :mod:`capi` --- ALE C-API -======= +========================== The :mod:`src` module .. doxygenfile:: ale.h - :project: ale + :project: ale .. versionadded:: 0.1.0 diff --git a/docs/source/library/capi/index.rst b/docs/source/library/capi/index.rst index 4758901..686caff 100644 --- a/docs/source/library/capi/index.rst +++ b/docs/source/library/capi/index.rst @@ -1,8 +1,6 @@ :mod:`capi` --- All ALE functions =================================== ------------------------------------------ - .. toctree:: capi diff --git a/docs/source/library/index.rst b/docs/source/library/index.rst index fa8f0a3..a36bcb2 100644 --- a/docs/source/library/index.rst +++ b/docs/source/library/index.rst @@ -5,9 +5,10 @@ Library Reference :Release: |version| :Date: |today| +----------------------------------------- + .. toctree:: :maxdepth: 2 capi/index python/index - ale/index diff --git a/docs/source/library/python/base.rst b/docs/source/library/python/base.rst index 1dddab6..d40200f 100644 --- a/docs/source/library/python/base.rst +++ b/docs/source/library/python/base.rst @@ -6,5 +6,6 @@ The :mod:`ale.drivers.base` module .. versionadded:: 0.1.0 .. automodule:: ale.drivers.base - :synopsis: - :members: + :synopsis: + :members: + :show-inheritance: diff --git a/docs/source/library/python/cassini_driver.rst b/docs/source/library/python/cassini_driver.rst index 4837fd6..635a1f9 100644 --- a/docs/source/library/python/cassini_driver.rst +++ b/docs/source/library/python/cassini_driver.rst @@ -8,3 +8,4 @@ The :mod:`ale.drivers.cassini_driver` module .. automodule:: ale.drivers.cassini_driver :synopsis: :members: + :show-inheritance: diff --git a/docs/source/library/python/index.rst b/docs/source/library/python/index.rst index 5ff4aa5..c8f2b79 100644 --- a/docs/source/library/python/index.rst +++ b/docs/source/library/python/index.rst @@ -1,9 +1,6 @@ :mod:`python` --- Input/Output Algorithms ============================================ - ------------------------------------------ - .. toctree:: base @@ -12,3 +9,5 @@ mdis_driver mro_driver util + +.. autofunction:: ale.drivers.__init__.load diff --git a/docs/source/library/python/lro_driver.rst b/docs/source/library/python/lro_driver.rst index 4e843b7..506d7af 100644 --- a/docs/source/library/python/lro_driver.rst +++ b/docs/source/library/python/lro_driver.rst @@ -8,3 +8,4 @@ The :mod:`ale.drivers.lro_driver` module .. automodule:: ale.drivers.lro_driver :synopsis: :members: + :show-inheritance: diff --git a/docs/source/library/python/mdis_driver.rst b/docs/source/library/python/mdis_driver.rst index aaf1e3f..12a96a1 100644 --- a/docs/source/library/python/mdis_driver.rst +++ b/docs/source/library/python/mdis_driver.rst @@ -8,3 +8,4 @@ The :mod:`ale.drivers.mdis_driver` module .. automodule:: ale.drivers.mdis_driver :synopsis: :members: + :show-inheritance: diff --git a/docs/source/library/python/mro_driver.rst b/docs/source/library/python/mro_driver.rst index 8e64a01..5a0165c 100644 --- a/docs/source/library/python/mro_driver.rst +++ b/docs/source/library/python/mro_driver.rst @@ -8,3 +8,4 @@ The :mod:`ale.drivers.mro_driver` module .. automodule:: ale.drivers.mro_driver :synopsis: :members: + :show-inheritance: -- GitLab