Opened 54 minutes ago

Last modified 52 minutes ago

#37099 new Cleanup/optimization

Add :dep: directive to Sphinx documentation

Reported by: Johannes Maron Owned by:
Component: Core (Other) Version: dev
Severity: Normal Keywords: sphinx, documentation, DEP
Cc: Johannes Maron Triage Stage: Unreviewed
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: yes UI/UX: no

Description (last modified by Johannes Maron)

For release notes in particular, but also other notifications, it would be wonderful to be able to link to DEPs.

Sphinx has a native :rfc: directive, which links to an RFC document. We have added other directives like :settings: in docs/_ext/djangodocs.py.

Since DEPs are currently moving around a lot I would suggest limiting this to finalized DEPs only for now.

I would suggest the name: :dep:

Change History (2)

comment:1 by Johannes Maron, 53 minutes ago

Description: modified (diff)

comment:2 by Johannes Maron, 52 minutes ago

Description: modified (diff)
Note: See TracTickets for help on using tickets.
Back to Top