Skip to main content

Allows to serve Sphinx generated docs from django.

Project description

django-docs allows to serve Sphinx generated docs directly from Django.


  • Python 3.6+ for Django 3.0 or higher



  1. Install django-docs package:

    pip install django-docs
  2. Add docs to INSTALLED_APPS in

  3. Add docs.urls to

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

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


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

Make sure to install test_requirements.txt first:

pip install -r test_requirements.txt
pip install -e .

You can run the tests with via:

python test


python docs/tests/

To run all tests against different versions of Django simply run:


Running the example project

Make sure to install requirements.txt first:

virtualenv env
. env/bin/activate
pip install -r test_requirements.txt
pip install -e .

You can run the example project with via:

cd example
python migrate
python runserver


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-docs-0.3.3.tar.gz (7.6 kB view hashes)

Uploaded source

Built Distribution

django_docs-0.3.3-py3-none-any.whl (8.7 kB view hashes)

Uploaded py3

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