Skip to content
Snippets Groups Projects
Commit e10ae15a authored by Jay's avatar Jay
Browse files

Doc refactor

parent 45619668
No related branches found
No related tags found
No related merge requests found
...@@ -3,6 +3,7 @@ ...@@ -3,6 +3,7 @@
# Docs # Docs
docs/doxyxml/ docs/doxyxml/
docs/build/*
# Byte-compiled / optimized / DLL files # Byte-compiled / optimized / DLL files
__pycache__/ __pycache__/
......
ALE C API #############################
====== Ephemeris Abstraction Library
#############################
.. doxygenfile:: ale.cpp :Release: |version|
:project: ale :Date: |today|
.. toctree::
:maxdepth: 2
library/capi/index
library/python/index
library/ale/index
\ No newline at end of file
ALE C API
=========
.. doxygenfile:: ale.cpp
:project: ale
\ No newline at end of file
:mod:`capi` --- Input/Output Algorithms :mod:`capi` --- A.L.E C-API
============================================ ============================================
The :mod:`src` module The :mod:`src` module
......
:mod:`capi` --- All A.L.E. functions :mod:`capi` --- All A.L.E. functions
=================================== ====================================
The internal data structures used by PyHAT to represent 1d, 2d, and n-dimensional data.
----------------------------------------- -----------------------------------------
......
...@@ -9,4 +9,5 @@ Library Reference ...@@ -9,4 +9,5 @@ Library Reference
:maxdepth: 2 :maxdepth: 2
capi/index capi/index
io/index python/index
ale/index
:mod:`cassini_driver` --- Cassini Driver Classes :mod:`cassini_driver` --- Cassini Driver Classes
============================================ ================================================
The :mod:`ale.drivers.cassini_driver` module The :mod:`ale.drivers.cassini_driver` module
......
:mod:`io` --- Input/Output Algorithms :mod:`python` --- Input/Output Algorithms
============================================ ============================================
The internal data structures used by PyHAT to represent 1d, 2d, and n-dimensional data.
----------------------------------------- -----------------------------------------
...@@ -9,7 +8,7 @@ The internal data structures used by PyHAT to represent 1d, 2d, and n-dimensiona ...@@ -9,7 +8,7 @@ The internal data structures used by PyHAT to represent 1d, 2d, and n-dimensiona
base base
cassini_driver cassini_driver
io
lro_driver lro_driver
mdis_driver mdis_driver
mro_driver mro_driver
util
:mod:`io` --- General Input/Output Algorithms :mod:`util` --- General Utilities
============================================ ============================================
The :mod:`ale.drivers` module The :mod:`ale.drivers` module
.. versionadded:: 0.1.0 .. versionadded:: 0.1.0
.. automodule:: ale.drivers.__init__.py
:synopsis:
:members:
.. automodule:: ale.util .. automodule:: ale.util
:synopsis: :synopsis:
:members: :members:
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment