8000 DOC Clarify Sphinx build instructions by mozgit · Pull Request #29743 · scikit-learn/scikit-learn · GitHub
[go: up one dir, main page]

Skip to content

DOC Clarify Sphinx build instructions #29743

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.

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

Merged
merged 3 commits into from
Aug 30, 2024
Merged

DOC Clarify Sphinx build instructions #29743

merged 3 commits into from
Aug 30, 2024

Conversation

mozgit
Copy link
Contributor
@mozgit mozgit commented Aug 30, 2024

Reference Issues/PRs

No PR is open. The issue was discovered while setting up the development environment

What does this implement/fix? Explain your changes.

The PR changes wording in development documentation part to provide more clarity

Any other comments?

@mozgit
Copy link
Contributor Author
mozgit commented Aug 30, 2024

@betatim could you please check this one?

Copy link
github-actions bot commented Aug 30, 2024

✔️ Linting Passed

All linting checks passed. Your pull request is in excellent shape! ☀️

Generated for commit: aaca155. Link to the linter CI: here

@lesteve lesteve changed the title Added clarity to Sphinx build instructions DOC Clarify Sphinx build instructions Aug 30, 2024
Copy link
Member
@betatim betatim left a comment

Choose a reason for hiding this comment

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

Except for my small comment this looks good to me

Following Tim's language tweak

Co-authored-by: Tim Head <betatim@gmail.com>
@betatim betatim enabled auto-merge (squash) August 30, 2024 10:11
Copy link
Member
@lesteve lesteve left a comment

Choose a reason for hiding this comment

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

Small tweaks.

FYI: for your next PR you can use another branch than main this way maintainers can directly push into your branch, which sometimes is handy.

Comment on lines +974 to +976
This will run all the examples, which takes a while. If you only want to generate
images for a few examples, you can pass their names (or parts of) to the build command.
The line below will run all examples with names starting with `plot_calibration`:
Copy link
Member
@lesteve lesteve Aug 30, 2024

Choose a reason for hiding this comment

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

Suggested change
This will run all the examples, which takes a while. If you only want to generate
images for a few examples, you can pass their names (or parts of) to the build command.
The line below will run all examples with names starting with `plot_calibration`:
This will run all the examples, which takes a while. You can also run only a few examples based on their file names.
Here is a way to run all examples with file names containing `plot_calibration`:

Comment on lines +982 to +983
You can also pass regular expressions to gain more advanced control over examples
you want run.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
You can also pass regular expressions to gain more advanced control over examples
you want run.
You can actually use regular expressions to have more control over which examples run.

@betatim betatim merged commit b5b24f8 into scikit-learn:main Aug 30, 2024
30 checks passed
MarcBresson pushed a commit to MarcBresson/scikit-learn that referenced this pull request Sep 2, 2024
Co-authored-by: Tim Head <betatim@gmail.com>
glemaitre pushed a commit to glemaitre/scikit-learn that referenced this pull request Sep 9, 2024
Co-authored-by: Tim Head <betatim@gmail.com>
glemaitre pushed a commit that referenced this pull request Sep 11, 2024
Co-authored-by: Tim Head <betatim@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants
0