#37099: Add :dep: directive to Sphinx documentation
-------------------------------------+-------------------------------------
Reporter: Johannes Maron | Owner: (none)
Type: | Status: new
Cleanup/optimization |
Component: Core (Other) | Version: dev
Severity: Normal | Resolution:
Keywords: sphinx, | Triage Stage:
documentation, DEP | Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------
Description changed by Johannes Maron:
Old description:
> 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.
New description:
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:`
--
--
Ticket URL: <https://code.djangoproject.com/ticket/37099#comment:1>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
--
You received this message because you are subscribed to the Google Groups
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To view this discussion visit
https://groups.google.com/d/msgid/django-updates/0107019e2b84313a-2961d519-a16d-4bee-ac1d-611933632738-000000%40eu-central-1.amazonses.com.
