8000 Fix reference to Matplotlib FAQ in doc/index.rst by adeak · Pull Request #22083 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]
Skip to content

Fix reference to Matplotlib FAQ in doc/index.rst #22083

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 1 commit into from
Jan 3, 2022
Merged

Fix reference to Matplotlib FAQ in doc/index.rst #22083

merged 1 commit into from
Jan 3, 2022

Conversation

adeak
Copy link
Contributor
@adeak adeak commented Jan 2, 2022 •
edited
Loading

PR Summary

The documentation's main page at https://matplotlib.org/stable/index.html (also https://matplotlib.org/devdocs/index.html) contains a link to the Matplotlib FAQ:

screenshot of doc main page

but the link points to the Python FAQ at https://docs.python.org/3/faq/index.html. I could reproduce this with a local build from main.

The raw .rst looks like this:

    How-tos
    ^^^^^^^
    - :doc:`Example gallery <gallery/index>`
    - :doc:`Matplotlib FAQ <faq/index>`

It seems that the <faq/index> is incorrect, it should be <users/faq/index>, and there happen to be two intersphinx items by that path in Python:

[
    'faq-index std:label -1 faq/index.html#$ Python Frequently Asked Questions',
    'faq/index std:doc -1 faq/index.html Python Frequently Asked Questions',
]

(I just decompressed the python.org intersphinx inventory and picked out the rows that contain faq/index).

Changing the path to <users/faq/index> seems to fix the link in a local build.

There are some other instances of faq/index without the users/ endpoint, and I wonder if any of them should also be amended:

$ cd doc
$ git grep -n 'faq/'
index.rst:59:    - :doc:`Matplotlib FAQ <users/faq/index>`
users/faq/environment_variables_faq.rst:3:.. redirect-from:: /faq/environment_variables_faq
users/faq/howto_faq.rst:3:.. redirect-from:: /faq/howto_faq
users/faq/index.rst:3:.. redirect-from:: /faq/index
users/faq/troubleshooting_faq.rst:3:.. redirect-from:: /faq/troubleshooting_faq
users/index.rst:19:   faq/index.rst
users/installing/index.rst:163:.. redirect-from:: /faq/installing_faq
users/installing/index.rst:164:.. redirect-from:: /users/faq/installing_faq

PR Checklist

Tests and Styling

  • [N/A] Has pytest style unit tests (and pytest passes).
  • [N/A] 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_wh 8000 ats_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).

@adeak
Copy link
Contributor Author
adeak commented Jan 2, 2022 •
edited
Loading

There are some unrelated-looking image comparison failures in CI. But now I see that this is happening across every PR.

@jklymak jklymak added the Documentation: website layout/behavior/styling changes label Jan 3, 2022
@jklymak jklymak added this to the v3.5-doc milestone Jan 3, 2022
@jklymak
Copy link
Member
jklymak commented Jan 3, 2022

Ooops, thanks for catching this. OTOH, I think the redirects are OK?

@jklymak jklymak merged commit 29cc1b3 into matplotlib:main Jan 3, 2022
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Jan 3, 2022
@jklymak @meeseeksmachine
Backport PR matplotlib#22083: Fix reference to Matplotlib FAQ in doc/…
be63226 
…index.rst
@meeseeksmachine meeseeksmachine mentioned this pull request Jan 3, 2022
Merged
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Jan 3, 2022
@jklymak @meeseeksmachine
Backport PR matplotlib#22083: Fix reference to Matplotlib FAQ in doc/…
6f3becb 
…index.rst
@meeseeksmachine meeseeksmachine mentioned this pull request Jan 3, 2022
Merged
@adeak
Copy link
Contributor Author
adeak commented Jan 3, 2022

Thanks, @jklymak. I didn't even notice that almost all those hits were redirects. And the one that wasn't seems to be OK, as it's correct relative to users/index.rst.

So yeah, seems all good.

timhoffm added a commit that referenced this pull request Jan 3, 2022
@timhoffm
Merge pull request #22096 from meeseeksmachine/auto-backport-of-pr-22…
c2eea67 
…083-on-v3.5.1-doc

Backport PR #22083 on branch v3.5.1-doc (Fix reference to Matplotlib FAQ in doc/index.rst)
timhoffm added a commit that referenced this pull request Jan 3, 2022
@timhoffm
Merge pull request #22095 from meeseeksmachine/auto-backport-of-pr-22…
bea29bf 
…083-on-v3.5.x

Backport PR #22083 on branch v3.5.x (Fix reference to Matplotlib FAQ in doc/index.rst)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jklymak jklymak jklymak approved these changes

Assignees
No one assigned
Labels
Documentation: website layout/behavior/styling changes
Projects
None yet
Milestone
v3.5-doc
Development

Successfully merging this pull request may close these issues.
2 participants
@adeak @jklymak
0