Add new hyperlink redirects and add links to docstring of documentation configuration file #2477
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
namurphy
added
no changelog entry needed
and removed
docs
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2477 +/- ##
=======================================
Coverage 96.93% 96.93%
=======================================
Files 104 104
Lines 9163 9163
=======================================
Hits 8882 8882
Misses 281 281 ☔ View full report in Codecov by Sentry. |
github-actions
bot
added
docs
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.
There was an update in
sphinx-issueswhich set the default for the:user:role to point tojackfan.us.kg/sponsors/usernameinstead ofjackfan.us.kg/username(sloria/sphinx-issues#129, sloria/sphinx-issues#131). This led to a number of redirects to show up when we did a linkcheck build, so I added a line todocs/conf.pyto specify that these redirects should be allowed when doing a linkcheck.I added some links to the docstring for
docs/conf.pythat point to helpful locations like our documentation guide and Sphinx's documentation.I also updated the GitHub username of a past contributor.