-
-
Notifications
You must be signed in to change notification settings - Fork 3.1k
Use Sphinx intersphinx or extlinks for common cross-refs, not full URLs #9081
Copy link
Copy link
Closed
Labels
type: docsdocumentation improvement, missing or needing clarificationdocumentation improvement, missing or needing clarification
Description
Via #9041 (comment) - these changes make our docs easier to read in plaintext, and give us a single location to update if something we're referencing moves (e.g. the docs for an upstream package). Specifically, let's:
- Ensure that we're using
intersphinxfor all our frequently-referenced docs - Check for manual links which could use
intersphinxin CI
(using something like @hoefling's special builder, which I want to copy for my projects) - Use
extlinksfor other patterns like Pytest issues and PRs
See sphinx-doc/sphinx#9626 for upstream progress on this; we'll adopt the checker once it's released by Sphinx ✨
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
type: docsdocumentation improvement, missing or needing clarificationdocumentation improvement, missing or needing clarification