#31029 closed Cleanup/optimization (fixed)
Link to more specific sections when using the :rfc: role.
| Reported by: | Baptiste Mispelon | Owned by: | Baptiste Mispelon |
|---|---|---|---|
| Component: | Documentation | Version: | dev |
| Severity: | Normal | Keywords: | |
| Cc: | Triage Stage: | Accepted | |
| Has patch: | yes | Needs documentation: | no |
| Needs tests: | no | Patch needs improvement: | no |
| Easy pickings: | no | UI/UX: | no |
Description
While looking at the documentation for the r format of the |date template filter [1], I ended up following the link to the RFC and had to look around the page to find the section that was actually relevant.
It turns out that sphinx's :ref: role supports linking to a specific section of an RFC (this feature is already used in a few places in Django's docs).
I think it would be useful to use that when possible and/or relevant.
So I did some grepping (using git grep -E ':rfc:\`[0-9]+\`') and for each match I tried to see if there was a specific section that was relevant to the context.
I skipped the release notes to save myself some work and because all the matches there were for unsupported versions anyway (10 matches with the latest one for the 1.10 release).
I also added a paragraph in the contributing guide so that other contributors might know about the feature too.
[1] https://docs.djangoproject.com/en/dev/ref/templates/builtins/#date
Change History (10)
comment:1 by , 4 years ago
comment:2 by , 4 years ago
| Owner: | changed from to |
|---|---|
| Status: | new → assigned |
| Summary: | Link to more specific sections when using the `:rfc:` role → Link to more specific sections when using the :rfc: role. |
| Triage Stage: | Unreviewed → Accepted |
comment:3 by , 4 years ago
| Patch needs improvement: | set |
|---|
comment:4 by , 4 years ago
| Patch needs improvement: | unset |
|---|
PR here