Skip to content
Snippets Groups Projects
Commit 818578df authored by acpaquette's avatar acpaquette Committed by GitHub
Browse files

Merge pull request #1 from jlaura/acpaquette-docs

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