From e10ae15a25a5464d2892c0bf6d8e3eab8b270a5c Mon Sep 17 00:00:00 2001
From: Jay <jlaura@usgs.gov>
Date: Fri, 21 Dec 2018 20:04:40 -0700
Subject: [PATCH] Doc refactor
---
.gitignore | 1 +
docs/source/index.rst | 16 ++++++++++++----
docs/source/library/ale/index.rst | 5 +++++
docs/source/library/capi/capi.rst | 2 +-
docs/source/library/capi/index.rst | 4 +---
docs/source/library/index.rst | 3 ++-
docs/source/library/{io => python}/base.rst | 0
.../library/{io => python}/cassini_driver.rst | 2 +-
docs/source/library/{io => python}/index.rst | 5 ++---
.../source/library/{io => python}/lro_driver.rst | 0
.../library/{io => python}/mdis_driver.rst | 0
.../source/library/{io => python}/mro_driver.rst | 0
.../library/{io/io.rst => python/util.rst} | 6 +-----
13 files changed, 26 insertions(+), 18 deletions(-)
create mode 100644 docs/source/library/ale/index.rst
rename docs/source/library/{io => python}/base.rst (100%)
rename docs/source/library/{io => python}/cassini_driver.rst (79%)
rename docs/source/library/{io => python}/index.rst (56%)
rename docs/source/library/{io => python}/lro_driver.rst (100%)
rename docs/source/library/{io => python}/mdis_driver.rst (100%)
rename docs/source/library/{io => python}/mro_driver.rst (100%)
rename docs/source/library/{io/io.rst => python/util.rst} (57%)
diff --git a/.gitignore b/.gitignore
index 1a9ef76..599ccfb 100644
--- a/.gitignore
+++ b/.gitignore
@@ -3,6 +3,7 @@
# Docs
docs/doxyxml/
+docs/build/*
# Byte-compiled / optimized / DLL files
__pycache__/
diff --git a/docs/source/index.rst b/docs/source/index.rst
index 190e16d..9253a74 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -1,5 +1,13 @@
-ALE C API
-======
+#############################
+Ephemeris Abstraction Library
+#############################
-.. doxygenfile:: ale.cpp
- :project: ale
+:Release: |version|
+:Date: |today|
+
+.. toctree::
+ :maxdepth: 2
+
+ library/capi/index
+ library/python/index
+ library/ale/index
\ No newline at end of file
diff --git a/docs/source/library/ale/index.rst b/docs/source/library/ale/index.rst
new file mode 100644
index 0000000..f830013
--- /dev/null
+++ b/docs/source/library/ale/index.rst
@@ -0,0 +1,5 @@
+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 20a5da8..8e15127 100644
--- a/docs/source/library/capi/capi.rst
+++ b/docs/source/library/capi/capi.rst
@@ -1,4 +1,4 @@
-:mod:`capi` --- Input/Output Algorithms
+:mod:`capi` --- A.L.E C-API
============================================
The :mod:`src` module
diff --git a/docs/source/library/capi/index.rst b/docs/source/library/capi/index.rst
index 1e6854f..5cc8f4a 100644
--- a/docs/source/library/capi/index.rst
+++ b/docs/source/library/capi/index.rst
@@ -1,7 +1,5 @@
:mod:`capi` --- All A.L.E. functions
-===================================
-
-The internal data structures used by PyHAT to represent 1d, 2d, and n-dimensional data.
+====================================
-----------------------------------------
diff --git a/docs/source/library/index.rst b/docs/source/library/index.rst
index 33fdb96..fa8f0a3 100644
--- a/docs/source/library/index.rst
+++ b/docs/source/library/index.rst
@@ -9,4 +9,5 @@ Library Reference
:maxdepth: 2
capi/index
- io/index
+ python/index
+ ale/index
diff --git a/docs/source/library/io/base.rst b/docs/source/library/python/base.rst
similarity index 100%
rename from docs/source/library/io/base.rst
rename to docs/source/library/python/base.rst
diff --git a/docs/source/library/io/cassini_driver.rst b/docs/source/library/python/cassini_driver.rst
similarity index 79%
rename from docs/source/library/io/cassini_driver.rst
rename to docs/source/library/python/cassini_driver.rst
index 3894b40..4837fd6 100644
--- a/docs/source/library/io/cassini_driver.rst
+++ b/docs/source/library/python/cassini_driver.rst
@@ -1,5 +1,5 @@
:mod:`cassini_driver` --- Cassini Driver Classes
-============================================
+================================================
The :mod:`ale.drivers.cassini_driver` module
diff --git a/docs/source/library/io/index.rst b/docs/source/library/python/index.rst
similarity index 56%
rename from docs/source/library/io/index.rst
rename to docs/source/library/python/index.rst
index 810ec2c..5ff4aa5 100644
--- a/docs/source/library/io/index.rst
+++ b/docs/source/library/python/index.rst
@@ -1,7 +1,6 @@
-: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
diff --git a/docs/source/library/io/lro_driver.rst b/docs/source/library/python/lro_driver.rst
similarity index 100%
rename from docs/source/library/io/lro_driver.rst
rename to docs/source/library/python/lro_driver.rst
diff --git a/docs/source/library/io/mdis_driver.rst b/docs/source/library/python/mdis_driver.rst
similarity index 100%
rename from docs/source/library/io/mdis_driver.rst
rename to docs/source/library/python/mdis_driver.rst
diff --git a/docs/source/library/io/mro_driver.rst b/docs/source/library/python/mro_driver.rst
similarity index 100%
rename from docs/source/library/io/mro_driver.rst
rename to docs/source/library/python/mro_driver.rst
diff --git a/docs/source/library/io/io.rst b/docs/source/library/python/util.rst
similarity index 57%
rename from docs/source/library/io/io.rst
rename to docs/source/library/python/util.rst
index e677dfc..375ceb2 100644
--- a/docs/source/library/io/io.rst
+++ b/docs/source/library/python/util.rst
@@ -1,14 +1,10 @@
-: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:
--
GitLab