Added API documentation

r-barnes · Dec 20, 2017 · 559f53f · 559f53f
1 parent d93d85b
commit 559f53f
Show file tree

Hide file tree

Showing 4 changed files with 37 additions and 5 deletions.
diff --git a/TODO b/TODO
@@ -1,2 +1,17 @@
 *Implement Peckham flow metric
-*Add LICENSE notices to the top of source files
+*Add LICENSE notices to the top of source files
+
+
+
+Documentation stuff
+===================
+
+More systematic way of including C++
+
+https://breathe.readthedocs.io/en/latest/quickstart.html
+.. doxygenindex::
+.. doxygenfunction::
+.. doxygenstruct::
+.. doxygenenum::
+.. doxygentypedef::
+.. doxygenclass::
diff --git a/docs/api.rst b/docs/api.rst
@@ -0,0 +1,9 @@
+RichDEM C++ Reference
+=====================
+
+.. doxygenindex::
+
+RichDEM Python Reference
+========================
+
+.. automodule:: richdem
diff --git a/docs/conf.py b/docs/conf.py
@@ -31,7 +31,7 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ['breathe']
+extensions = ['sphinx.ext.autodoc', 'breathe', 'sphinx.ext.coverage']
 
 breathe_projects            = {'richdem': '.build/doxygenxml/'}
 breathe_default_project     = 'richdem'

diff --git a/docs/index.rst b/docs/index.rst
@@ -6,18 +6,26 @@ RichDEM --- High-Performance Terrain Analysis
     Contents:
 
 .. toctree::
-   :maxdepth: 1
+   :maxdepth: 2
 
    intro
    philosophy
    parsable_output
    citations
+   using_it
 
 .. toctree::
-   :caption: Using It
+   :caption: Operations
    :maxdepth: 2
 
-   using_it
+   depression_filling
+   flow_accumulation
+
+.. toctree::
+   :caption: api
+   :maxdepth: 2
+
+   api
 
 .. toctree::
    :caption: Testing and Correctness