add code documentation stub

This commit is contained in:
Jan Dittberner 2014-05-31 13:27:21 +02:00
parent efae7ec120
commit ef47cf7862
3 changed files with 18 additions and 3 deletions

13
docs/code.rst Normal file
View File

@ -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

View File

@ -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']

View File

@ -15,6 +15,7 @@ Contents:
install
deploy
code
changelog