Fix broken references in docs: First pass#2616
Merged
einarf merged 15 commits intodevelopmentfrom Mar 23, 2025
Merged
Conversation
einarf
changed the title
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
We have around 500 broken references in docs. These are mainly rst links to members in pyglet and arcade. It can be rst links both in the source and the docs itself. To combat future issues related to this we should enable
nitpickymode i sphinx.This is quite a bit of work to clean up so we'll just have to trickle in fixes over time in this branch.
We also have quite a few source files that can use more rst references to make the api docs easier to navigate.