diff --git a/docs/source/index.rst b/docs/source/index.rst index 4404a5779d80e0231bba165a4362e30d840d0f24..8e2ad1cc2225bd803d36aa83fdf1402b889a3682 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 f830013a705391fbe8bb8c42be0f1b683b806772..e348dca254e31e51b4222ea66c12fedd9c144a9f 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 812e8cbd5706ab92f1140caf284c2abae48ac08e..243294f78ed4275d5e06e8cf0c7a5d8cd26738c7 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 47589011bc0df05097996436e9471fb9b535b9a5..686caff5196824445fce00ea2ec0d1b36d53c372 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 fa8f0a38aa68f3c2ee197d210aa7aad742522405..a36bcb2b8099f70b025f4613e25aaa10a426aec4 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 1dddab6805858d55e26fc613605257cf13f036c1..d40200f4cb8c491f4db753def20e7141196e910b 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 4837fd6e5a509ef168aa5df55ee591f2df4d3550..635a1f93de2e3ade80560d64f20d5ea8f3db7966 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 5ff4aa53600900217a03e17e8a544bc68e3a4dbd..c8f2b795e299ce7a3d4b2e374d0f49537fc16736 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 4e843b7802031f4f0747aeaa64ea185a5333463b..506d7afe4380b3a72e7ae45474c820269c045a41 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 aaf1e3fb257d080acf0d2e5f49397beb0081cf73..12a96a1de0ad0936ecb82a3623768055fcfd6f8d 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 8e64a013e95873cba983664b10b8096532ffe29c..5a0165c23e480b4cdd11a7e023956a59753eaaff 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: