BSD Ports

textproc/py-sphinxcontrib-django 2.5 DragonFly

Improve the Sphinx autodoc for Django classes

System
DragonFly
Repository
DPorts
Maintainer
[email protected] (as in FreeBSD)
License
APACHE20
Categories
python, textproc
Package size
29.3 KiB, 151.1 KiB installed

Description

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:)

In the other systems

SystemPortVersion
DragonFlytextproc/py-sphinxcontrib-django2.5
FreeBSDtextproc/py-sphinxcontrib-django2.5_1
HardenedBSDtextproc/py-sphinxcontrib-django2.5_1
GhostBSDtextproc/py-sphinxcontrib-django2.5_1

Install

Binary package:

pkg install py311-sphinxcontrib-django

From DPorts:

cd /usr/dports/textproc/py-sphinxcontrib-django && make install clean

Dependencies

Run dependencies 4

No port depends on this one.