Skip to main content

Allows to serve Sphinx generated docs from django.

Project description

https://img.shields.io/travis/littlepea/django-docs.svg?style=flat-square https://img.shields.io/pypi/v/django-docs.svg?style=flat-square https://img.shields.io/badge/license-New%20BSD-blue.svg?style=flat-square

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

Dependencies

  • Python 2.7-3.6 for Django 1.8 - 1.11
  • Python 3.4-3.6 for Django 2.0 or higher

Credits

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 = [
        ...
        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

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 setup.py test

or:

python docs/tests/runtests.py

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

tox

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 manage.py migrate
python manage.py runserver

Screenshot

https://www.evernote.com/l/AHRVMNRZKLVPaoCgJouF_-Pz7rfeDzGF32sB/image.png

Project details


Download files

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

Files for django-docs, version 0.3.1
Filename, size File type Python version Upload date Hashes
Filename, size django_docs-0.3.1-py3-none-any.whl (8.9 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size django-docs-0.3.1.tar.gz (6.7 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page