chore: Add references to docs to make relative, not direct, references#716
Conversation
|
Note to self: There are a few |
feanil
left a comment
feanil
left a comment
There was a problem hiding this comment.
Some inconsistencies in labeling but otherwise looks good.
|
|
||
| .. Below is the display in the left sidebar on RTD. Please omit leading 0's | ||
|
|
||
| .. _OEP XXXX OEP Template: |
There was a problem hiding this comment.
I'm not sure why sphinx is not complaining about this, this label has been defined twice also it's only different from the label in oep-templates/adr-based-template.rst by one dash. Are these template files not processed by default or something?
There was a problem hiding this comment.
The top-level oep-templates directory is not processed in the build, the top-level oeps directory is considered the source dir.
sarina
force-pushed
the
sarina/refs-cleanup
branch
from
7610a37 to
6e04ccf
Compare
sarina
force-pushed
the
sarina/refs-cleanup
branch
from
6e04ccf to
30a1cab
Compare
|
@feanil anything else you'd like to see on this one? |
2 participants
Usage of
:doc:is an antipattern. It is fragile and prone to breaking cross references when docs are moved or renamed.Adding in
.. _reference:syntax to files and headings means cross-references can instead be made with the:ref:directive, which will (presuming the references themselves are not deleted or renamed) be more robust to docs refactorings.