Update api docs

pytroll · Nov 3, 2018 · 9303d24 · 9303d24
1 parent c734897
commit 9303d24
Show file tree

Hide file tree

Showing 3 changed files with 33 additions and 0 deletions.
diff --git a/doc/api/donfig.rst b/doc/api/donfig.rst
@@ -0,0 +1,30 @@
+donfig package
+==============
+
+Submodules
+----------
+
+donfig.config\_obj module
+-------------------------
+
+.. automodule:: donfig.config_obj
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+donfig.utils module
+-------------------
+
+.. automodule:: donfig.utils
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: donfig
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/doc/conf.py b/doc/conf.py
@@ -12,6 +12,8 @@
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
+# To generate apidoc modules:
+#     sphinx-apidoc -f -T -o api ../donfig ../donfig/tests ../donfig/version.py
 import os
 import sys
 sys.path.insert(0, os.path.abspath('..'))

diff --git a/doc/index.rst b/doc/index.rst
@@ -18,6 +18,7 @@ locations.
 
    installation
    configuration
+   Donfig API <api/donfig>