Skip to content

Commit b9e3cbb

Browse files
committed
Add a _readme suffix to skbuild_docs
Signed-off-by: Cristian Le <[email protected]>
1 parent 21b3782 commit b9e3cbb

File tree

4 files changed

+5
-5
lines changed

4 files changed

+5
-5
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ as environment variables. `tool.scikit-build` is used in toml, `skbuild.` for
144144
below:
145145

146146
<!-- [[[cog
147-
from scikit_build_core.settings.skbuild_docs import mk_skbuild_docs
147+
from scikit_build_core.settings.skbuild_docs_readme import mk_skbuild_docs
148148
149149
print("\n```toml\n[tool.scikit-build]")
150150
print(mk_skbuild_docs())

docs/api/scikit_build_core.settings.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,10 +41,10 @@ scikit\_build\_core.settings.json\_schema module
4141
:show-inheritance:
4242
:undoc-members:
4343

44-
scikit\_build\_core.settings.skbuild\_docs module
45-
-------------------------------------------------
44+
scikit\_build\_core.settings.skbuild\_docs\_readme module
45+
---------------------------------------------------------
4646

47-
.. automodule:: scikit_build_core.settings.skbuild_docs
47+
.. automodule:: scikit_build_core.settings.skbuild_docs_readme
4848
:members:
4949
:show-inheritance:
5050
:undoc-members:

tests/test_settings_docs.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
from __future__ import annotations
22

33
from scikit_build_core.settings.documentation import DCDoc, mk_docs
4-
from scikit_build_core.settings.skbuild_docs import mk_skbuild_docs
4+
from scikit_build_core.settings.skbuild_docs_readme import mk_skbuild_docs
55
from scikit_build_core.settings.skbuild_model import ScikitBuildSettings
66

77

0 commit comments

Comments
 (0)