sphinxcontrib-django is a sphinx extension which improves the documentation of
Django apps.
Improvements for the output of Sphinx's autodoc for Django classes:
- List all model and form fields as class parameters
- Improve model field representations
- Link related and reverse related fields to the referenced class
- Hide irrelevant runtime information like declared_fieldsets, fieldsets and
Meta from classes
- Add information about autogenerated methods
- Fix intersphinx mappings to Django modules
- Custom text roles to cross-reference the documentations of Django (:setting:,
:templatetag:, :templatefilter:, :fieldlookup:) and Sphinx (:event:,
:confval:)
NOTE: If this package has multiple flavors (see below), then use one of them instead of the name specified above. NOTE: This is a Python port. Instead of py311-sphinxcontrib-django listed in the above command, you can pick from the names under the Packages section.
*: Switch consumers over to Django 5.2
Django 4.2 reached its End-of-Life on 7th April 2026 and Django 5.2 is
the new LTS (= Long Term Support) release which will be supported until
April 2028.
* Switch most ports that use www/py-django42 to www/py-django52.
* Where necessary, remove PORTSCOUT, which is no longer needed because
an update to a newer version that no longer supports Django 4.2 should
now be possible.
* Bump PORTREVISION due dependency change where necessary.
PR: 291707
Reviewed by: sunpoet (python)
Differential Revision: https://reviews.freebsd.org/D56966
textproc/py-sphinxcontrib-django: Add py-sphinxcontrib-django 2.5
sphinxcontrib-django is a sphinx extension which improves the documentation of
Django apps.
Improvements for the output of Sphinx's autodoc for Django classes:
- List all model and form fields as class parameters
- Improve model field representations
- Link related and reverse related fields to the referenced class
- Hide irrelevant runtime information like declared_fieldsets, fieldsets and
Meta from classes
- Add information about autogenerated methods
- Fix intersphinx mappings to Django modules
- Custom text roles to cross-reference the documentations of Django (:setting:,
:templatetag:, :templatefilter:, :fieldlookup:) and Sphinx (:event:,
:confval:)
