Opened 3 weeks ago
Last modified 3 days ago
#37099 assigned Cleanup/optimization
Add :dep: directive to Sphinx documentation
| Reported by: | Johannes Maron | Owned by: | Wasif Shahzad |
|---|---|---|---|
| Component: | Core (Other) | Version: | dev |
| Severity: | Normal | Keywords: | sphinx, documentation, DEP |
| Cc: | Johannes Maron | Triage Stage: | Someday/Maybe |
| 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 I would suggest limiting this to finalized DEPs only for now.
I would suggest the name: :dep:
Change History (6)
comment:1 by , 3 weeks ago
| Description: | modified (diff) |
|---|
comment:2 by , 3 weeks ago
| Description: | modified (diff) |
|---|
comment:3 by , 3 weeks ago
| Owner: | set to |
|---|---|
| Status: | new → assigned |
comment:4 by , 3 weeks ago
| Triage Stage: | Unreviewed → Someday/Maybe |
|---|
comment:5 by , 7 days ago
| Owner: | removed |
|---|---|
| Status: | assigned → new |
comment:6 by , 3 days ago
| Owner: | set to |
|---|---|
| Status: | new → assigned |
Note:
See TracTickets
for help on using tickets.
Note that #26408 shows a similar problem as stated.
I think having a more permanent DEP link solution first would be really useful.