docs: add a reference page for CLI utilities #1080
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Henry Schreiner <[email protected]>
Signed-off-by: Henry Schreiner <[email protected]>
henryiii
commented
May 15, 2025
There was a problem hiding this comment.
Pull Request Overview
This PR adds a new CLI reference documentation page and updates multiple CLI entry points by enhancing their ArgumentParser definitions with explicit prog and description parameters. It also updates the changelog, Sphinx configuration, and dependency list to support these changes and a patch release for Python 3.14 support.
- Updated ArgumentParser definitions in various CLI modules
- Added a new CLI reference page in the docs
- Updated Sphinx configuration and dependency list in pyproject.toml
Reviewed Changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| src/scikit_build_core/file_api/reply.py | Updated ArgumentParser with explicit prog and description |
| src/scikit_build_core/file_api/query.py | Updated ArgumentParser with explicit prog and description |
| src/scikit_build_core/file_api/_cattrs_converter.py | Updated ArgumentParser by adding a description for cattrs conversion |
| src/scikit_build_core/builder/wheel_tag.py | Updated ArgumentParser with explicit prog and description |
| src/scikit_build_core/build/main.py | Added prog to ArgumentParser and updated description for clarity |
| pyproject.toml | Added dependency on sphinxcontrib-programoutput to docs requirements |
| docs/reference/cli.md | Created a new CLI reference documentation page |
| docs/index.md | Updated index to include the new CLI reference page |
| docs/conf.py | Modified the Sphinx extensions list by adding new extensions |
| docs/about/changelog.md | Updated changelog with new changes for version 0.11.3 |
|
"python" isn't the python used to run sphinx, great. I feel like I ran into this before. Edit: Oh, this is only on Windows. |
Signed-off-by: Henry Schreiner <[email protected]>
henryiii
force-pushed
the
henryiii/docs/cli
branch
from
e536155 to
efd66c5
Compare
Signed-off-by: Henry Schreiner <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adding a reference page for this.
There's also a
pathlib._local.Pathwarning when building the docs we should try to fix eventually.Also preparing for a patch release with the 3.14 support and a bug fix.