-
-
Notifications
You must be signed in to change notification settings - Fork 25.9k
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
Conversation
@betatim could you please check this one? |
There was a problem hiding this 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>
There was a problem hiding this 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.
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`: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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`: |
You can also pass regular expressions to gain more advanced control over examples | ||
you want run. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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. |
Co-authored-by: Tim Head <betatim@gmail.com>
Co-authored-by: Tim Head <betatim@gmail.com>
Co-authored-by: Tim Head <betatim@gmail.com>
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?