Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Fix doc bugs found in 3.5.3 #23641

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 3 commits into from
Aug 17, 2022
Merged

Fix doc bugs found in 3.5.3 #23641

merged 3 commits into from
Aug 17, 2022

Conversation

QuLogic
Copy link
Member

@QuLogic QuLogic commented Aug 16, 2022

PR Summary

This fixes several dead links and HTML errors found after building docs for 3.5.3.

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).

QuLogic added 3 commits August 16, 2022 17:05
@QuLogic
DOC: Fix broken links and cross-references
e91caf1
@QuLogic
DOC: Add HTML5 doctype to redirect pages
a36e5a8 
Though these are not intended to be seen, this silences validators.
@QuLogic
Fix links to rcParams sample matplotlibrc
e5df3de 
The anchor ID was changed, but as this was entered manually, it did not
break the build.

Instead, insert a pending cross-reference so that Sphinx will resolve it
and warn if it breaks.

The output changes minimally from `external` to `internal` class, and
also gains `std std-ref` classes due to it being a standard reference.
@QuLogic QuLogic added this to the v3.5-doc milestone Aug 16, 2022
@tfpf
Copy link
Contributor

tfpf commented Aug 17, 2022

Since a link in test_quiver.py has also been updated, can this dead link be updated, too?

matplotlib/lib/matplotlib/tests/test_mathtext.py

Line 64 in 9e6afd6

# https://developer.mozilla.org/en-US/docs/Mozilla/MathML_Project/MathML_Torture_Test

I think https://www-archive.mozilla.org/projects/mathml/demo/texvsmml.xhtml is the correct one.

@tacaswell
Copy link
Member

@tfpf Can you open a PR with that change?

@tacaswell tacaswell merged commit 944b99a into matplotlib:main Aug 17, 2022
@lumberbot-app
Copy link

lumberbot-app bot commented Aug 17, 2022

Owee, I'm MrMeeseeks, Look at me.

There seem to be a conflict, please backport manually. Here are approximate instructions:

  1. Checkout backport branch and update it.
git checkout v3.5.x
git pull
  1. Cherry pick the first parent branch of the this PR on top of the older branch:
git cherry-pick -x -m1 944b99a826a1b3509cbf7add49dccb14db9240fb
  1. You will likely have some merge/cherry-pick conflict here, fix them and commit:
git commit -am 'Backport PR #23641: Fix doc bugs found in 3.5.3'
  1. Push to a named branch:
git push YOURFORK v3.5.x:auto-backport-of-pr-23641-on-v3.5.x
  1. Create a PR against branch v3.5.x, I would have named this PR:

"Backport PR #23641 on branch v3.5.x (Fix doc bugs found in 3.5.3)"

And apply the correct labels and milestones.

Congratulations — you did some good work! Hopefully your backport PR will be tested by the continuous integration and merged soon!

Remember to remove the Still Needs Manual Backport label once the PR gets merged.

If these instructions are inaccurate, feel free to suggest an improvement.

@lumberbot-app
Copy link

lumberbot-app bot commented Aug 17, 2022

Owee, I'm MrMeeseeks, Look at me.

There seem to be a conflict, please backport manually. Here are approximate instructions:

  1. Checkout backport branch and update it.
git checkout v3.5.3-doc
git pull
  1. Cherry pick the first parent branch of the this PR on top of the older branch:
git cherry-pick -x -m1 944b99a826a1b3509cbf7add49dccb14db9240fb
  1. You will likely have some merge/cherry-pick conflict here, fix them and commit:
git commit -am 'Backport PR #23641: Fix doc bugs found in 3.5.3'
  1. Push to a named branch:
git push YOURFORK v3.5.3-doc:auto-backport-of-pr-23641-on-v3.5.3-doc
  1. Create a PR against branch v3.5.3-doc, I would have named this PR:

"Backport PR #23641 on branch v3.5.3-doc (Fix doc bugs found in 3.5.3)"

And apply the correct labels and milestones.

Congratulations — you did some good work! Hopefully your backport PR will be tested by the continuous integration and merged soon!

Remember to remove the Still Needs Manual Backport label once the PR gets merged.

If these instructions are inaccurate, feel free to suggest an improvement.

@QuLogic QuLogic deleted the fix-doc-bugs branch August 17, 2022 21:34
QuLogic pushed a commit to QuLogic/matplotlib that referenced this pull request Aug 17, 2022
@tacaswell @QuLogic
Backport PR matplotlib#23641: Fix doc bugs found in 3.5.3
950825f
QuLogic pushed a commit to QuLogic/matplotlib that referenced this pull request Aug 17, 2022
@tacaswell @QuLogic
Backport PR matplotlib#23641: Fix doc bugs found in 3.5.3
81d9717
QuLogic added a commit that referenced this pull request Aug 17, 2022
@QuLogic
Merge pull request #23652 from QuLogic/auto-backport-of-pr-23641-on-v…
a4c888f 
…3.5.3-doc

Backport PR #23641 on branch v3.5.3-doc (Fix doc bugs found in 3.5.3)
QuLogic added a commit that referenced this pull request Aug 17, 2022
@QuLogic
Merge pull request #23651 from QuLogic/auto-backport-of-pr-23641-on-v…
2614c05 
…3.5.x

Backport PR #23641 on branch v3.5.x (Fix doc bugs found in 3.5.3)
@QuLogic QuLogic mentioned this pull request Aug 26, 2022
Merged
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tacaswell tacaswell tacaswell approved these changes

Assignees
No one assigned
Labels
Documentation
Projects
None yet
Milestone
v3.5-doc
Development

Successfully merging this pull request may close these issues.
3 participants
@QuLogic @tfpf @tacaswell