🌐 AI搜索 & 代理 主页
Skip to content

FIX: update doc EXAMPLE_HEADER to match sphinx-gallery #28173

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
Closed
rcomer wants to merge 1 commit into from
Closed

FIX: update doc EXAMPLE_HEADER to match sphinx-gallery #28173

rcomer wants to merge 1 commit into from

Conversation

@rcomer
Copy link
Member

@rcomer rcomer commented May 5, 2024

PR summary

Followed the instructions at

matplotlib/lib/matplotlib/tests/test_doc.py

Lines 6 to 10 in e253aa2

We have copied EXAMPLE_HEADER and modified it to include meta keywords.
This test monitors that the version we have copied is still the same as
the EXAMPLE_HEADER in sphinx-gallery. If sphinx-gallery changes its
EXAMPLE_HEADER, this test will start to fail. In that case, please update
the monkey-patching of EXAMPLE_HEADER in conf.py.

Note that in CI this test only runs under Appveyor because the others do not install sphinx-gallery.

PR checklist

@github-actions github-actions bot added the Documentation: build building the docs label May 5, 2024
@rcomer rcomer added this to the v3.8.5 milestone May 5, 2024
@rcomer
Copy link
Member Author

rcomer commented May 5, 2024

Ref: sphinx-gallery/sphinx-gallery#1255

@rcomer
Copy link
Member Author

rcomer commented May 5, 2024

Ooops - just realised this is already covered by #28103.

@rcomer rcomer closed this May 5, 2024
@rcomer rcomer deleted the sphinx-header branch May 5, 2024 17:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

Documentation: build building the docs status: duplicate

Projects

None yet

Milestone

v3.8.5

Development

Successfully merging this pull request may close these issues.

1 participant

@rcomer