From 974de95eb321b03ddfbecbb6edc4abf44f99e172 Mon Sep 17 00:00:00 2001 From: kakwa Date: Fri, 17 Jul 2015 08:30:32 +0200 Subject: [PATCH] beginning api documentaion for ppolicy and backend --- docs/backend_api.rst | 8 ++++++++ docs/conf.py | 2 +- docs/index.rst | 3 ++- docs/ppolicy_api.rst | 7 +++++++ 4 files changed, 18 insertions(+), 2 deletions(-) create mode 100644 docs/backend_api.rst create mode 100644 docs/ppolicy_api.rst diff --git a/docs/backend_api.rst b/docs/backend_api.rst new file mode 100644 index 0000000..c485f89 --- /dev/null +++ b/docs/backend_api.rst @@ -0,0 +1,8 @@ +Package ldapcherry.backend +========================== + +.. automodule:: ldapcherry.backend + :members: + :undoc-members: + :show-inheritance: + diff --git a/docs/conf.py b/docs/conf.py index 1062054..2531003 100644 --- 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'] diff --git a/docs/index.rst b/docs/index.rst index 01ef314..437deef 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -7,7 +7,8 @@ install deploy + backend_api + ppolicy_api changelog - .. include:: ../README.rst diff --git a/docs/ppolicy_api.rst b/docs/ppolicy_api.rst new file mode 100644 index 0000000..a6d2364 --- /dev/null +++ b/docs/ppolicy_api.rst @@ -0,0 +1,7 @@ +Package ldapcherry.ppolicy +========================== + +.. automodule:: ldapcherry.ppolicy + :members: + :undoc-members: + :show-inheritance: