chore: Add references to docs to make relative, not direct, references #716
+352
−238
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Note to self: There are a few |
feanil
requested changes
Jun 11, 2025
| @@ -2,6 +2,8 @@ | |||
|
|
|||
| .. 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
commented
Jun 11, 2025
oeps/architectural-decisions/oep-0032-arch-unique-identifier-for-users.rst
Outdated
Show resolved
Hide resolved
sarina
commented
Jun 11, 2025
sarina
commented
Jun 11, 2025
sarina
commented
Jun 11, 2025
sarina
commented
Jun 11, 2025
sarina
commented
Jun 11, 2025
sarina
commented
Jun 11, 2025
oeps/architectural-decisions/oep-0052-arch-event-bus-architecture.rst
Outdated
Show resolved
Hide resolved
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.