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 3.6+ for Django 3.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.

Source Distribution

django-docs-0.3.3.tar.gz (7.6 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

Details for the file django-docs-0.3.3.tar.gz.

File metadata

  • Download URL: django-docs-0.3.3.tar.gz
  • Upload date:
  • Size: 7.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.13

File hashes

Hashes for django-docs-0.3.3.tar.gz
Algorithm Hash digest
SHA256 f2b489ab122f6dc84a1a8f0e2be86dcc8b3958b31b2d0a4603570c47228408d0
MD5 97626475bbb15160326c46d46923acd6
BLAKE2b-256 ba91571b5baf368ecf889472b0d4ca3cafe224add8544da6c05ee808c3de2d96

See more details on using hashes here.

File details

Details for the file django_docs-0.3.3-py3-none-any.whl.

File metadata

  • Download URL: django_docs-0.3.3-py3-none-any.whl
  • Upload date:
  • Size: 8.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.13

File hashes

Hashes for django_docs-0.3.3-py3-none-any.whl
Algorithm Hash digest
SHA256 7e85c5b5dd0b9b4d24099740ab16ac0449ff8acdfe8b0e26c08f3a4e50e7e5e1
MD5 cc533c21ec544524155713852d20c16c
BLAKE2b-256 c1cb69ea9a1b9af32b66cb2ecbeb4aae532a222dcf4bd8755f8e8054799819ae

See more details on using hashes here.

Supported by

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