django-sphinx-docs

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

This is a fork of https://github.com/littlepea/django-docs to support Django 4.0+.

Dependencies

• Python 3.10+
• Django 3.2+

Installation

1. Install django-sphinx-docs package:

   pip install django-sphinx-docs
   

2. Add django_sphinx_docs to INSTALLED_APPS in settings.py:

   INSTALLED_APPS = (
       ...
       'django_sphinx_docs',
       ...
   )
   

3. Add django_sphinx_docs.urls to urls.py:

   urlpatterns = [
       ...
       path('docs/', include('django_sphinx_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

uv run pytest

Running the example project

cd example
uv run python manage.py migrate
uv run python manage.py runserver