Skip to main content

Provides a way to integrate a protected sphinx based documentation within your django app.

Project description


This `Django <>`_ app has for purpose to integrate
protected sphinx based documentation .



django-documentation depends on `Sphinx <>`_

Installing django-simple-feedback

Install into your python path using pip::

pip install django-documentation
pip install -e git+git://

Add *'documentation'* to your INSTALLED_APPS in


Add *'(r'^docs/', include('documentation.urls')'* to your urls::

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


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


django-documentation also comes with a command goodies ::

./ makedoc

to generate the documentation.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-documentation-1.1.tar.gz (6.1 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page