sphinxcontrib-django
Improve the Sphinx autodoc for Django classes.
Decision gist · record as of 2026-08-14
Yes. This is a stable, actively maintained extension for a common use case—documenting Django projects with Sphinx. It has low install friction, no known vulnerabilities, permissive licensing, and solves a real problem (Django's internal structure makes vanilla autodoc output cluttered and incomplete). Install it if you're using Sphinx to document a Django application.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Requires Django settings module to be configured; the extension emits a django-configured event after django.setup() completes for custom initialization code.
- Low friction installation with only three runtime dependencies (Django, Sphinx, pprintpp).
- Actively maintained as of 2026-07-20 with a stable release history since 2017-12-07, supporting modern Python versions (3.8 through 3.11) and recent Django versions (3.2, 4.1, 4.2).
License · maintenance · safety
Apache2 2.0 License (permissive) — Licensed under Apache 2.0 (permissive), allowing free use, modification, and distribution with minimal restrictions—suitable for both open-source and commercial projects.
last release 2023-09-26 (1053 days) · last repo commit 2026-07-20 · 51 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 122,107 downloads/mo, #11,960 on PyPI
Alternatives
Verify before relying
pip install sphinxcontrib-django
# In your Sphinx conf.py:
import sys, os
sys.path.insert(0, os.path.abspath("../src"))
extensions = ["sphinxcontrib_django"]
django_settings = "myapp.settings"- Whether the package works with Django versions beyond 4.2 or Python versions beyond 3.11.
- Performance impact when documenting large Django projects with many models and fields.
- Compatibility with recent Sphinx versions not explicitly listed in classifiers.
What it is and what it does
sphinxcontrib-django is a Sphinx extension designed to make Django application documentation more complete and readable. It hooks into Sphinx's autodoc system to automatically extract and display Django model and form fields as class parameters, improve how those fields are represented in the generated docs, and create intelligent links between related and reverse-related fields. It also hides internal Django implementation details that clutter documentation (like declared_fieldsets and Meta classes) and adds information about autogenerated methods.
The extension is configured by adding it to your Sphinx conf.py alongside a django_settings module path. It provides custom text roles for cross-referencing Django documentation (settings, template tags, filters, field lookups) and Sphinx internals (events, config values), and includes optional features like displaying database table names and controlling how many field choices to show. It handles Django setup during the documentation build process and emits a django-configured event so you can run custom initialization code safely.
Use it for
- Generate complete API documentation for Django models that automatically lists all fields and their types without manual effort.
- Create cross-referenced Django project documentation where field relationships link directly to the related model classes.
- Build cleaner autodoc output by filtering out internal Django implementation details that add noise to generated docs.
- Document custom Django admin forms and model fields with improved field representations and metadata.
- Set up monkeypatching or custom initialization during documentation builds via the django-configured event hook.
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
Yes.
This is a stable, actively maintained extension for a common use case—documenting Django projects with Sphinx. It has low install friction, no known vulnerabilities, permissive licensing, and solves a real problem (Django's internal structure makes vanilla autodoc output cluttered and incomplete). Install it if you're using Sphinx to document a Django application.
Install
sphinxcontrib-django on PyPI
Before you install
Low friction installation with only three runtime dependencies (Django, Sphinx, pprintpp). Actively maintained as of 2026-07-20 with a stable release history since 2017-12-07, supporting modern Python versions (3.8 through 3.11) and recent Django versions (3.2, 4.1, 4.2).
Requires Django settings module to be configured; the extension emits a django-configured event after django.setup() completes for custom initialization code.
License in practice
Licensed under Apache 2.0 (permissive), allowing free use, modification, and distribution with minimal restrictions—suitable for both open-source and commercial projects.
Quickstart
pip install sphinxcontrib-django
# In your Sphinx conf.py:
import sys, os
sys.path.insert(0, os.path.abspath("../src"))
extensions = ["sphinxcontrib_django"]
django_settings = "myapp.settings"Verify before relying
- Whether the package works with Django versions beyond 4.2 or Python versions beyond 3.11.
- Performance impact when documenting large Django projects with many models and fields.
- Compatibility with recent Sphinx versions not explicitly listed in classifiers.
Package facts
| License | Apache2 2.0 License permissive |
| Python support | Supports the current Python release >=3.8 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 3 packagesDjangoSphinxpprintpp |
| Maintenance | Actively maintained 1,053 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 122,107 / month, #11,960 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | Development Status :: 5 - Production/StableEnvironment :: Web EnvironmentFramework :: DjangoFramework :: Django :: 3.2Framework :: Django :: 4.1Framework :: Django :: 4.2Framework :: Sphinx :: ExtensionIntended Audience :: DevelopersLicense :: OSI Approved :: Apache Software LicenseOperating System :: OS IndependentProgramming Language :: PythonProgramming Language :: Python :: 3.10Programming Language :: Python :: 3.11Programming Language :: Python :: 3.8Programming Language :: Python :: 3.9Topic :: Internet :: WWW/HTTPTopic :: Internet :: WWW/HTTP :: Dynamic ContentTopic :: Software Development :: Libraries :: Application FrameworksTopic :: Software Development :: Libraries :: Python Modules |
Evidence: sphinxcontrib_django-2.5-py3-none-any.whl
Tags
Let your AI agent find packages like this
Example. Real query, live index.
You found this page by searching. An agent finds it by wishing: SkillFed indexes 14,416 PyPI packages by what they can do, searchable in plain language.
wish › “sphinx django autodoc extension”
- sphinxcontrib-djangoA Sphinx extension that enhances autodoc output for Django classes by…
- autodocsummA Sphinx extension that enhances autodoc with automatic summary…
- autodoc_pydanticSphinx extension that automatically generates documentation for…
Give your agent the search over MCP, or paste the wish link into any chat.
More Python Modules packages
Converts domain names between Unicode and ASCII-compatible encoding (Punycode) according to IDNA 2008 and Unicode Technical Standard 46, with security validation and broader script coverage than the standard library.
Install it if you work with internationalized domain names, need to validate domains, or use HTTP clients that depend on it transitively.
Setuptools is a Python build backend and package management tool that handles building, distributing, and installing Python packages, including support for C/C++ extension modules.
PyYAML parses and emits YAML 1.1 data format, enabling serialization and deserialization of configuration files and Python objects to and from human-readable YAML text.
Pydantic validates Python data structures against type hints, coercing and checking input at runtime to ensure it matches a declared schema.
Provides reusable metadata objects for use with PEP-593 `typing.Annotated` to express common constraints like bounds, collection sizes, and predicates on types.
Install it if you use or build libraries that need to express type constraints in a standardized, inspectable way—or if you want to annotate your own types with…
Provides runtime tools to inspect and introspect Python type annotations, enabling programmatic examination of type hints at execution time.
See also autodocsumm · sphinx-issues · sphinxcontrib-autoyaml · sphinxcontrib-apidoc · autoclasstoc · sphinx-autodoc-typehints · autodoc_pydantic · sphinx-autodoc2 · sphinxcontrib-napoleon · sphobjinv