Repository navigation
📝 docs: link pages back to the repository - #177
Merged
Merged
Conversation
Set Furo's source_repository so each page gets view and edit buttons pointing at GitHub, and add a GitHub footer icon. Closes tox-dev#174
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
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.
The documentation had no way back to the repository (#174): readers who wanted the source, an issue tracker or the file behind a page had to find GitHub on their own. 📝 Every page now carries "view this page" and "edit this page" buttons that open its source file on GitHub, and the footer shows a GitHub icon linking to the repository.
The buttons come from Furo's VCS link support, driven by the repository, branch and docs directory in the Sphinx config, which also feeds the existing issue and PR shortcuts. The footer icon follows Furo's embedded-SVG recipe, with the SVG kept as a file next to the logo and inlined at build time.