DOC: remove dead "Show Source" links by StefRe · Pull Request #23919 · matplotlib/matplotlib · GitHub
Skip to content

DOC: remove dead "Show Source" links - #23919

Merged
timhoffm merged 1 commit into
matplotlib:mainfrom
StefRe:DOC/source_link
Sep 18, 2022
Merged

DOC: remove dead "Show Source" links#23919
timhoffm merged 1 commit into
matplotlib:mainfrom
StefRe:DOC/source_link

Conversation

@StefRe

@StefRe StefRe commented Sep 17, 2022

Copy link
Copy Markdown
Contributor

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

  • [N/A] Has pytest style unit tests (and pytest passes).
  • Is Flake 8 compliant (install flake8-docstrings and run flake8 --docstring-convention=all).

Documentation

  • [N/A] New features are documented, with examples if plot related.
  • [N/A] New features have an entry in doc/users/next_whats_new/ (follow instructions in README.rst there).
  • [N/A] API changes documented in doc/api/next_api_changes/ (follow instructions in README.rst there).
  • Documentation is sphinx and numpydoc compliant (the docs should build without error).

@StefRe
StefRe marked this pull request as draft September 17, 2022 09:40
@StefRe
StefRe marked this pull request as ready for review September 17, 2022 10:19
Comment thread doc/conf.py Outdated

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't want the searchbox

Suggested change

Unsure if we need edit-this-page. At least in the the CI-built docs it does not seem to have an effect.

@StefRe StefRe Sep 17, 2022

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.
@StefRe StefRe changed the title DOC: remove dead soure code links DOC: remove dead "Show Source" links Sep 17, 2022
@tacaswell tacaswell added this to the v3.6-doc milestone Sep 17, 2022
@StefRe
StefRe requested a review from timhoffm September 18, 2022 17:31
@timhoffm timhoffm added the Documentation: website layout/behavior/styling changes label Sep 18, 2022
@timhoffm
timhoffm merged commit b637f41 into matplotlib:main 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
@StefRe
StefRe deleted the DOC/source_link branch September 19, 2022 05:06
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
@ksunden ksunden mentioned this pull request Feb 20, 2023
6 tasks
@timhoffm timhoffm mentioned this pull request Mar 5, 2024
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation: website layout/behavior/styling changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Doc]: Missing source files

3 participants