Opened 3 hours ago
Last modified 89 minutes ago
#37099 assigned Cleanup/optimization
Add :dep: directive to Sphinx documentation — at Version 1
| 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 )
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](https://forum.djangoproject.com/t/moving-files-in-dsf-repos/45034/), I would suggest limiting this to finalized DEPs only for now.
I would suggest the name: :dep:
Note:
See TracTickets
for help on using tickets.