beginning api documentaion for ppolicy and backend

2015-07-17 08:30:32 +02:00 · 2015-07-17 08:30:32 +02:00 · 974de95eb3
parent 2508739838
commit 974de95eb3
4 changed files with 18 additions and 2 deletions
--- a/docs/backend_api.rst
+++ b/docs/backend_api.rst
@ -0,0 +1,8 @@
+Package ldapcherry.backend
+==========================
+
+.. automodule:: ldapcherry.backend
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
--- a/docs/conf.py
+++ b/docs/conf.py
@ -26,7 +26,7 @@ sys.path.insert(0, os.path.abspath('..'))

 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.viewcode']
+extensions = ['sphinx.ext.viewcode', 'sphinx.ext.todo', 'sphinx.ext.autodoc']

 # Add any paths that contain templates here, relative to this directory.
 #templates_path = ['_templates']
--- a/docs/index.rst
+++ b/docs/index.rst
@ -7,7 +7,8 @@
    
    install
    deploy
+    backend_api
+    ppolicy_api
    changelog

-
 .. include:: ../README.rst
--- a/docs/ppolicy_api.rst
+++ b/docs/ppolicy_api.rst
@ -0,0 +1,7 @@
+Package ldapcherry.ppolicy
+==========================
+
+.. automodule:: ldapcherry.ppolicy
+    :members:
+    :undoc-members:
+    :show-inheritance: