Docs: Fix undeclared labels after refactor + fix root causes #10059
Conversation
This file contains 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
ericholscher
approved these changes
Feb 22, 2023
| # The default setting for intersphinx_disabled_reftypes can cause some pretty bad | ||
| # breakage because we have rtd and rtd-dev stable versions in our mappings. | ||
| # Hence, if we refactor labels, we won't see broken references, since the | ||
| # currently active stable mapping keeps resolving. |
| @@ -19,7 +19,7 @@ and then click on :guilabel:`Traffic Analytics`. | |||
|
|
|||
| Traffic analytics demo | |||
|
|
|||
| You can also access to analytics data from :ref:`search results <server-side-search/index:Search Analytics>`. | |||
There was a problem hiding this comment.
I kinda like the refs because they hoverxref. Should we standardize on using them instead of :doc:? We should probably just fix readthedocs/sphinx-hoverxref#18
There was a problem hiding this comment.
I kinda like the refs because they hoverxref.
This is true. I would say that we should add actual labels to headlines so we can freely change headlines and not have to update references as a result (that adds more work to a simple headline improvement).
There was a problem hiding this comment.
I think we should defer to readthedocs/sphinx-hoverxref#18 because of the widespread use and need of :doc:. But would be great to fix this.
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.
📚 Documentation previews 📚
docs): https://docs--10059.org.readthedocs.build/en/10059/dev): https://dev--10059.org.readthedocs.build/en/10059/