mirror of
https://git.freebsd.org/ports.git
synced 2025-05-15 00:31:51 -04:00
cc1080363e
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:)
14 lines
670 B
Text
14 lines
670 B
Text
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:)
|