1
0
mirror of https://git.FreeBSD.org/ports.git synced 2024-12-27 05:10:36 +00:00

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:)
This commit is contained in:
Po-Chuan Hsieh 2024-09-30 20:43:28 +08:00
parent 029625db06
commit cc1080363e
No known key found for this signature in database
GPG Key ID: 9A4BD10F002DD04B
4 changed files with 43 additions and 0 deletions

View File

@ -1620,6 +1620,7 @@
SUBDIR += py-sphinxcontrib-bitbucket
SUBDIR += py-sphinxcontrib-blockdiag
SUBDIR += py-sphinxcontrib-devhelp
SUBDIR += py-sphinxcontrib-django
SUBDIR += py-sphinxcontrib-fulltoc
SUBDIR += py-sphinxcontrib-htmlhelp
SUBDIR += py-sphinxcontrib-httpdomain

View File

@ -0,0 +1,25 @@
PORTNAME= sphinxcontrib-django
PORTVERSION= 2.5
CATEGORIES= textproc python
MASTER_SITES= PYPI
PKGNAMEPREFIX= ${PYTHON_PKGNAMEPREFIX}
MAINTAINER= sunpoet@FreeBSD.org
COMMENT= Improve the Sphinx autodoc for Django classes
WWW= https://github.com/sphinx-doc/sphinxcontrib-django
LICENSE= APACHE20
LICENSE_FILE= ${WRKSRC}/LICENSE
BUILD_DEPENDS= ${PYTHON_PKGNAMEPREFIX}setuptools>=0:devel/py-setuptools@${PY_FLAVOR} \
${PYTHON_PKGNAMEPREFIX}wheel>=0:devel/py-wheel@${PY_FLAVOR}
RUN_DEPENDS= ${PYTHON_PKGNAMEPREFIX}django42>=3.2:www/py-django42@${PY_FLAVOR} \
${PYTHON_PKGNAMEPREFIX}pprintpp>=0:devel/py-pprintpp@${PY_FLAVOR} \
${PYTHON_PKGNAMEPREFIX}sphinx>=3.4.0,1:textproc/py-sphinx@${PY_FLAVOR}
USES= python
USE_PYTHON= autoplist concurrent pep517
NO_ARCH= yes
.include <bsd.port.mk>

View File

@ -0,0 +1,3 @@
TIMESTAMP = 1727314492
SHA256 (sphinxcontrib-django-2.5.tar.gz) = 45a54c0cc1f641d6c15872828862f0738348ca8d7d5b92777bcaa530678c2cc4
SIZE (sphinxcontrib-django-2.5.tar.gz) = 23788

View File

@ -0,0 +1,14 @@
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:)