Django-documentation

This Django app has for purpose to integrate protected sphinx based documentation .

Installation

Depedencies

django-documentation depends on Sphinx

Installing django-documentation

Install into your python path using pip. Either install a stable release from PyPi:

pip install django-documentation

Or install the development version directly from GitHub:

pip install -e git+git://github.com/Narsil/django-documentation.git#egg=django-documentation

Add 'documentation' to your INSTALLED_APPS in settings.py:

INSTALLED_APPS = (
    …
    'documentation',
)

Add django-documentation to your urls:

urlpatterns = patterns(
    '',
    ....
    url(r'^docs/', include('documentation.urls'), namespace='documentation'),
)

Settings

Set up where is your documentation, and a function that has a user for argument and returns True if user is allowed to see the doc. If you plan on using lambda user: True, then you probably should not be using this app, as staticfiles would be better suited for this task.

DOCUMENTATION_ROOT = '/path/to/docs/'
DOCUMENTATION_ACCESS_FUNCTION = lambda user: user.is_staff

The DOCUMENATION_ROOT is the root of your sphinx doc where the Makefile exists, if you html docs is placed somewhere else than DOCUMENTATION_ROOT + '_build/html/' then you can override it with:

DOCUMENTATION_HTML_ROOT = '/my/other/location/

Note that django-documentation serves the content via x-sendfile when DEBUG is False, otherwise it uses django.views.static.serve. To override use

DOCUMENTATION_XSENDFILE = True

django-documentation also comes with a command goodies

./manage.py makedoc

to generate the documentation.