django-docs

https://travis-ci.org/littlepea/django-docs.png?branch=master

Allows to serve Sphinx generated docs from django.

Installation

  1. Install django-docs package:

    pip install django-docs
  2. Add docs to INSTALLED_APPS in settings.py:

    INSTALLED_APPS = (
        ...
        'docs',
        ...
    )
  3. Add docs.urls to urls.py:

    urlpatterns = patterns('',
        ...
        url(r'^docs/', include('docs.urls')),
        ...
    )
  4. Customize configuration:

    DOCS_ROOT = os.path.join(PROJECT_PATH, '../docs/_build/html')
    DOCS_ACCESS = 'staff'
    

Configuration

DOCS_ROOT (required)

Absolute path to the root directory of html docs generated by Sphinx (just like STATIC_ROOT / MEDIA_ROOT settings).

DOCS_ACCESS (optional)

Docs access level (public by default). Possible values:

  • public - (default) docs are visible to everyone
  • login_required - docs are visible only to authenticated users
  • staff - docs are visible only to staff users (user.is_staff == True)
  • superuser - docs are visible only to superusers (user.is_superuser == True)

Running the Tests

You can run the tests with via:

python setup.py test

or:

python docs/tests/runtests.py

Screenshot

http://screencloud.net//img/screenshots/6521a4af4845acceaad80bd64f842a61.png

Indices and tables