Skip to content

docs: generate config value reference #1052

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

Merged
merged 3 commits into from
May 6, 2025
Merged

docs: generate config value reference #1052

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
27f6977
Add a _readme suffix to skbuild_docs
LecrisUT Apr 25, 2025
9571dd3
Generate config reference
LecrisUT Apr 25, 2025
f654914
Document how to pass the confvals
LecrisUT Apr 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ as environment variables. `tool.scikit-build` is used in toml, `skbuild.` for
below:

<!-- [[[cog
from scikit_build_core.settings.skbuild_docs import mk_skbuild_docs
from scikit_build_core.settings.skbuild_docs_readme import mk_skbuild_docs

print("\n```toml\n[tool.scikit-build]")
print(mk_skbuild_docs())
Expand Down
14 changes: 11 additions & 3 deletions docs/api/scikit_build_core.settings.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,10 +41,18 @@ scikit\_build\_core.settings.json\_schema module
:show-inheritance:
:undoc-members:

scikit\_build\_core.settings.skbuild\_docs module
-------------------------------------------------
scikit\_build\_core.settings.skbuild\_docs\_readme module
---------------------------------------------------------

.. automodule:: scikit_build_core.settings.skbuild_docs_readme
:members:
:show-inheritance:
:undoc-members:

scikit\_build\_core.settings.skbuild\_docs\_sphinx module
---------------------------------------------------------

.. automodule:: scikit_build_core.settings.skbuild_docs
.. automodule:: scikit_build_core.settings.skbuild_docs_sphinx
:members:
:show-inheritance:
:undoc-members:
Expand Down
1 change: 1 addition & 0 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@ about/changelog

api/scikit_build_core
schema
reference/configs
```

## Indices and tables
Expand Down
Loading
Loading