[docs] Add "Edit on GH" links, fix searchbox, widen viewport, better legibility #833
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
A few things got refactored in sphinx, especially for 4.x. Therefore, use provided helpers. As a reference for the future, always look at what the "basic" sphinx theme (bundled as `sphinx/themes/basic`) does. See: - sphinx-doc/sphinx@a957d6f710 - sphinx-doc/sphinx#4916 - sphinx-doc/sphinx#4915 - readthedocs/sphinx_rtd_theme#1021
This also necessitates a bit of CSS.
This increases legibility and improves contrast.
The implementation closely matches `sphinx-rtd-theme`, see https://github.com/readthedocs/sphinx_rtd_theme/blob/9264091087620d421b0804c00937b00980ac3916/sphinx_rtd_theme/breadcrumbs.html#L19-L40 and https://github.com/readthedocs/sphinx_rtd_theme/blob/ef9a0584ef6d43f898a2b787a541e31a79f560e8/docs/configuring.rst#file-wide-metadata GitHub svg icon taken from Wikipedia (Wikimedia Commons) Usage: https://github.com/logos > Do these awesome things: > - Use the Octocat or GitHub logo to link to GitHub > - Use the Mark in social buttons to link to your GitHub > profile or project > - Use the Octocat or GitHub logo to advertise that your > product has built-in GitHub integration > - Use the Octocat or GitHub logo in a blog post or news > article about GitHub
A name that's broken across two lines looks ugly
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.
For a visual comparison see:
Before:
After:
