8000 Update requirements to add PyStemmer to doc-requirements and environment by Anson0028 · Pull Request #29019 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]
Skip to content

Update requirements to add PyStemmer to doc-requirements and environment #29019

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 2 commits into from
Oct 25, 2024
Merged

Update requirements to add PyStemmer to doc-requirements and environment #29019

merged 2 commits into from
Oct 25, 2024

Conversation

Anson0028
Copy link
Contributor

PR summary

This pull request updates the dependencies for building the documentation by adding PyStemmer to requirements/doc/doc-requirements.txt and environment.yml. The addition of PyStemmer is intended to improve the efficiency of Sphinx documentation builds by enabling stemming for search indexing. This change addresses the need for better search functionality in the generated documentation and may result in a performance improvement during the build process.

Relevant files updated:

requirements/doc/doc-requirements.txt
environment.yml

closes #28570

PR checklist

github-actions[bot]
github-actions bot reviewed Oct 25, 2024
View reviewed changes
Copy link
@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Thank you for opening your first PR into Matplotlib!

If you have not heard from us in a week or so, please leave a new comment below and that should bring it to our attention. Most of our reviewers are volunteers and sometimes things fall through the cracks.

You can also join us on gitter for real-time discussion.

For details on testing, writing docs, and our review process, please see the developer guide

We strive to be a welcoming and open project. Please follow our Code of Conduct.

timhoffm
timhoffm reviewed Oct 25, 2024
View reviewed changes
@timhoffm timhoffm added this to the v3.9-doc milestone Oct 25, 2024
@rcomer rcomer merged commit 835d512 into matplotlib:main Oct 25, 2024
47 checks passed
@lumberbot-app Lumberbot (App)
Copy link
lumberbot-app bot commented Oct 25, 2024

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.9.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 835d5125a320c9f440a1bc7ef18f74e37d3cb031
  1. You will likely have some merge/cherry-pick conflict here, fix them and commit:
git commit -am 'Backport PR #29019: Update requirements to add PyStemmer to doc-requirements and environment'
  1. Push to a named branch:
git push YOURFORK v3.9.x:auto-backport-of-pr-29019-on-v3.9.x
  1. Create a PR against branch v3.9.x, I would have named this PR:

"Backport PR #29019 on branch v3.9.x (Update requirements to add PyStemmer to doc-requirements and environment)"

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 Lumberbot (App)
Copy link
lumberbot-app bot commented Oct 25, 2024

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.9.2-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 835d5125a320c9f440a1bc7ef18f74e37d3cb031
  1. You will likely have some merge/cherry-pick conflict here, fix them and commit:
git commit -am 'Backport PR #29019: Update requirements to add PyStemmer to doc-requirements and environment'
  1. Push to a named branch:
git push YOURFORK v3.9.2-doc:auto-backport-of-pr-29019-on-v3.9.2-doc
  1. Create a PR against branch v3.9.2-doc, I would have named this PR:

"Backport PR #29019 on branch v3.9.2-doc (Update requirements to add PyStemmer to doc-requirements and environment)"

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.

@rcomer
Copy link
Member
rcomer commented Oct 25, 2024

Thanks @Anson0028 and congratulations on your first PR in Matplotlib! We hope to hear from you again.

@QuLogic QuLogic modified the milestones: v3.9-doc, v3.10.0 Oct 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@github-actions github-actions[bot] github-actions[bot] left review comments

@timhoffm timhoffm timhoffm approved these changes

@rcomer rcomer rcomer approved these changes

Assignees
No one assigned
Labels
Documentation
Projects
First Time Contributors
Status: Merged
Milestone
v3.10.0
Development

Successfully merging this pull request may close these issues.

[MNT]: Try improving doc build speed by using PyStemmer
5 participants
@Anson0028 @rcomer @timhoffm @QuLogic @Anson0000
0