From ef47cf7862de926fa0d86ef849cc3deb379e8731 Mon Sep 17 00:00:00 2001 From: Jan Dittberner Date: Sat, 31 May 2014 13:27:21 +0200 Subject: [PATCH] add code documentation stub --- docs/code.rst | 13 +++++++++++++ docs/conf.py | 7 ++++--- docs/index.rst | 1 + 3 files changed, 18 insertions(+), 3 deletions(-) create mode 100644 docs/code.rst diff --git a/docs/code.rst b/docs/code.rst new file mode 100644 index 0000000..f079065 --- /dev/null +++ b/docs/code.rst @@ -0,0 +1,13 @@ +================== +Code documentation +================== + +.. index:: Django + +gvaldap is implemented as a set of `Django`_ apps. + +.. _Django: https://www.djangoproject.com/ + +.. automodule:: ldapentities + +.. automodule:: osusers diff --git a/docs/conf.py b/docs/conf.py index 07386c0..1b5e738 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -12,12 +12,13 @@ # All configuration values have a default; values that are commented out # serve to show the default. -#import sys, os +import sys +import os # If extensions (or modules to document with autodoc) are in another directory, # 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. -#sys.path.insert(0, os.path.abspath('.')) +sys.path.insert(0, os.path.abspath(os.path.join('..', 'gvaldap'))) # -- General configuration ----------------------------------------------------- @@ -26,7 +27,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 = ['releases'] +extensions = ['releases', '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 0bf07e1..0297002 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -15,6 +15,7 @@ Contents: install deploy + code changelog