DOC: remove dead "Show Source" links #23919
Merged
Conversation
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
5d753f1 to
f2888f4
Compare
timhoffm
reviewed
Sep 17, 2022
doc/conf.py
Outdated
| "navbar_end": ["theme-switcher", "version-switcher", "mpl_icon_links"], | ||
| "page_sidebar_items": [ | ||
| "page-toc.html", | ||
| "searchbox.html", |
There was a problem hiding this comment.
We don't want the searchbox
Suggested change
| "searchbox.html", |
Unsure if we need edit-this-page. At least in the the CI-built docs it does not seem to have an effect.
There was a problem hiding this comment.
Sorry, I didn't carefully check the built docs - fixed.
Although I don't quite understand why searchbox and edit-this-page are not shown in the current docs: mpl-sphinx-theme inherits from pydata-sphinx-theme which by default includes both searchbox and edit-this-page in the sidebar. Where is this excluded/overridden in theme.conf or conf.py?
Remove dead links to source code as _source directory was intentionally removed in the circle config config.yml because store_artifcats uploads files one by one which takes an inordinate amount of time.
f2888f4 to
99a0115
Compare
timhoffm
approved these changes
Sep 18, 2022
meeseeksmachine
pushed a commit
to meeseeksmachine/matplotlib
that referenced
this pull request
Sep 18, 2022
meeseeksmachine
pushed a commit
to meeseeksmachine/matplotlib
that referenced
this pull request
Sep 18, 2022
timhoffm
added a commit
that referenced
this pull request
Sep 19, 2022
…919-on-v3.6.x Backport PR #23919 on branch v3.6.x (DOC: remove dead "Show Source" links)
timhoffm
added a commit
that referenced
this pull request
Sep 19, 2022
…919-on-v3.6.0-doc Backport PR #23919 on branch v3.6.0-doc (DOC: remove dead "Show Source" links)
melissawm
pushed a commit
to melissawm/matplotlib
that referenced
this pull request
Dec 19, 2022
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.
PR Summary
Remove dead links to source code as _source directory was intentionally removed in the circle config config.yml because store_artifcats uploads files one by one which takes an inordinate amount of time.
Closes #23876 .
PR Checklist
Tests and Styling
pytestpasses).flake8-docstringsand runflake8 --docstring-convention=all).Documentation
doc/users/next_whats_new/(follow instructions in README.rst there).doc/api/next_api_changes/(follow instructions in README.rst there).