[Django] #37099: Add :dep: directive to Sphinx documentation

[Django]

#37099: Add :dep: directive to Sphinx documentation
-------------------------------------+-------------------------------------
Reporter: Johannes Maron | Type:
| Cleanup/optimization
Status: new | Component: Core
| (Other)
Version: dev | Severity: Normal
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
-------------------------------------+-------------------------------------
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.
--
Ticket URL: <https://code.djangoproject.com/ticket/37099>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

[Django]

#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]

#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.
>
> I would suggest the name: `:dep:`

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`.

[https://forum.djangoproject.com/t/moving-files-in-dsf-repos/45034/ 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:`

--
--

Ticket URL: <https://code.djangoproject.com/ticket/37099#comment:2>

[Django]

#37099: Add :dep: directive to Sphinx documentation
-------------------------------------+-------------------------------------

Reporter: Johannes Maron | Owner: Vaibhav
Type: | Pant
Cleanup/optimization | Status: assigned

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
-------------------------------------+-------------------------------------

Changes (by Vaibhav Pant):

* owner: (none) => Vaibhav Pant
* status: new => assigned

--
Ticket URL: <https://code.djangoproject.com/ticket/37099#comment:3>

[Django]

#37099: Add :dep: directive to Sphinx documentation
-------------------------------------+-------------------------------------
Reporter: Johannes Maron | Owner: Vaibhav
Type: | Pant
Cleanup/optimization | Status: assigned
Component: Core (Other) | Version: dev
Severity: Normal | Resolution:
Keywords: sphinx, | Triage Stage:

documentation, DEP | Someday/Maybe

Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------

Changes (by Sarah Boyce):

* stage: Unreviewed => Someday/Maybe

Comment:

Note that #26408 shows a similar problem as stated.
I think having a more permanent DEP link solution first would be really
useful.
--
Ticket URL: <https://code.djangoproject.com/ticket/37099#comment:4>

[Django]

#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 | Someday/Maybe
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------

Changes (by Vaibhav Pant):

* owner: Vaibhav Pant => (none)
* status: assigned => new

--
Ticket URL: <https://code.djangoproject.com/ticket/37099#comment:5>