Skip to content

Commit fcded34

Browse files
henryiiihenryiii
committed
docs: add API docs
Signed-off-by: Henry Schreiner <[email protected]>
1 parent 8906f1f commit fcded34

17 files changed

+377
-81
lines changed

‎.readthedocs.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,3 +19,4 @@ python:
1919
path: .
2020
extra_requirements:
2121
- docs
22+
- pyproject

‎README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@
1414
[![Gitter][gitter-badge]][gitter-link]
1515
-->
1616

17+
<!-- SPHINX-START -->
18+
1719
Features over classic Scikit-build:
1820

1921
- Better warnings, errors, and logging

‎docs/Makefile‎

Lines changed: 0 additions & 20 deletions
This file was deleted.

‎docs/api/scikit_build_core.build.rst‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
scikit\_build\_core.build package
2+
=================================
3+
4+
.. automodule:: scikit_build_core.build
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
8+
9+
Submodules
10+
----------
11+
12+
scikit\_build\_core.build.sdist module
13+
--------------------------------------
14+
15+
.. automodule:: scikit_build_core.build.sdist
16+
:members:
17+
:undoc-members:
18+
:show-inheritance:
19+
20+
scikit\_build\_core.build.wheel module
21+
--------------------------------------
22+
23+
.. automodule:: scikit_build_core.build.wheel
24+
:members:
25+
:undoc-members:
26+
:show-inheritance:

‎docs/api/scikit_build_core.builder.rst‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
scikit\_build\_core.builder package
2+
===================================
3+
4+
.. automodule:: scikit_build_core.builder
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
8+
9+
Submodules
10+
----------
11+
12+
scikit\_build\_core.builder.builder module
13+
------------------------------------------
14+
15+
.. automodule:: scikit_build_core.builder.builder
16+
:members:
17+
:undoc-members:
18+
:show-inheritance:
19+
20+
scikit\_build\_core.builder.generator module
21+
--------------------------------------------
22+
23+
.. automodule:: scikit_build_core.builder.generator
24+
:members:
25+
:undoc-members:
26+
:show-inheritance:
27+
28+
scikit\_build\_core.builder.get\_requires module
29+
------------------------------------------------
30+
31+
.. automodule:: scikit_build_core.builder.get_requires
32+
:members:
33+
:undoc-members:
34+
:show-inheritance:
35+
36+
scikit\_build\_core.builder.macos module
37+
----------------------------------------
38+
39+
.. automodule:: scikit_build_core.builder.macos
40+
:members:
41+
:undoc-members:
42+
:show-inheritance:
43+
44+
scikit\_build\_core.builder.sysconfig module
45+
--------------------------------------------
46+
47+
.. automodule:: scikit_build_core.builder.sysconfig
48+
:members:
49+
:undoc-members:
50+
:show-inheritance:
51+
52+
scikit\_build\_core.builder.wheel\_tag module
53+
---------------------------------------------
54+
55+
.. automodule:: scikit_build_core.builder.wheel_tag
56+
:members:
57+
:undoc-members:
58+
:show-inheritance:

‎docs/api/scikit_build_core.file_api.model.rst‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
scikit\_build\_core.file\_api.model package
2+
===========================================
3+
4+
.. automodule:: scikit_build_core.file_api.model
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
8+
9+
Submodules
10+
----------
11+
12+
scikit\_build\_core.file\_api.model.cache module
13+
------------------------------------------------
14+
15+
.. automodule:: scikit_build_core.file_api.model.cache
16+
:members:
17+
:undoc-members:
18+
:show-inheritance:
19+
20+
scikit\_build\_core.file\_api.model.cmakefiles module
21+
-----------------------------------------------------
22+
23+
.. automodule:: scikit_build_core.file_api.model.cmakefiles
24+
:members:
25+
:undoc-members:
26+
:show-inheritance:
27+
28+
scikit\_build\_core.file\_api.model.codemodel module
29+
----------------------------------------------------
30+
31+
.. automodule:: scikit_build_core.file_api.model.codemodel
32+
:members:
33+
:undoc-members:
34+
:show-inheritance:
35+
36+
scikit\_build\_core.file\_api.model.common module
37+
-------------------------------------------------
38+
39+
.. automodule:: scikit_build_core.file_api.model.common
40+
:members:
41+
:undoc-members:
42+
:show-inheritance:
43+
44+
scikit\_build\_core.file\_api.model.directory module
45+
----------------------------------------------------
46+
47+
.. automodule:: scikit_build_core.file_api.model.directory
48+
:members:
49+
:undoc-members:
50+
:show-inheritance:
51+
52+
scikit\_build\_core.file\_api.model.index module
53+
------------------------------------------------
54+
55+
.. automodule:: scikit_build_core.file_api.model.index
56+
:members:
57+
:undoc-members:
58+
:show-inheritance:
59+
60+
scikit\_build\_core.file\_api.model.toolchains module
61+
-----------------------------------------------------
62+
63+
.. automodule:: scikit_build_core.file_api.model.toolchains
64+
:members:
65+
:undoc-members:
66+
:show-inheritance:

‎docs/api/scikit_build_core.file_api.rst‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
scikit\_build\_core.file\_api package
2+
=====================================
3+
4+
.. automodule:: scikit_build_core.file_api
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
8+
9+
Subpackages
10+
-----------
11+
12+
.. toctree::
13+
:maxdepth: 4
14+
15+
scikit_build_core.file_api.model
16+
17+
Submodules
18+
----------
19+
20+
scikit\_build\_core.file\_api.query module
21+
------------------------------------------
22+
23+
.. automodule:: scikit_build_core.file_api.query
24+
:members:
25+
:undoc-members:
26+
:show-inheritance:
27+
28+
scikit\_build\_core.file\_api.reply module
29+
------------------------------------------
30+
31+
.. automodule:: scikit_build_core.file_api.reply
32+
:members:
33+
:undoc-members:
34+
:show-inheritance:

‎docs/api/scikit_build_core.resources.find_python.rst‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
scikit\_build\_core.resources.find\_python package
2+
==================================================
3+
4+
.. automodule:: scikit_build_core.resources.find_python
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs/api/scikit_build_core.resources.rst‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
scikit\_build\_core.resources package
2+
=====================================
3+
4+
.. automodule:: scikit_build_core.resources
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
8+
9+
Subpackages
10+
-----------
11+
12+
.. toctree::
13+
:maxdepth: 4
14+
15+
scikit_build_core.resources.find_python

‎docs/api/scikit_build_core.rst‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
scikit\_build\_core package
2+
===========================
3+
4+
.. automodule:: scikit_build_core
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
8+
9+
Subpackages
10+
-----------
11+
12+
.. toctree::
13+
:maxdepth: 4
14+
15+
scikit_build_core.build
16+
scikit_build_core.builder
17+
scikit_build_core.file_api
18+
scikit_build_core.resources
19+
scikit_build_core.settings
20+
scikit_build_core.setuptools
21+
22+
Submodules
23+
----------
24+
25+
scikit\_build\_core.cmake module
26+
--------------------------------
27+
28+
.. automodule:: scikit_build_core.cmake
29+
:members:
30+
:undoc-members:
31+
:show-inheritance:
32+
33+
scikit\_build\_core.errors module
34+
---------------------------------
35+
36+
.. automodule:: scikit_build_core.errors
37+
:members:
38+
:undoc-members:
39+
:show-inheritance:
40+
41+
scikit\_build\_core.program\_search module
42+
------------------------------------------
43+
44+
.. automodule:: scikit_build_core.program_search
45+
:members:
46+
:undoc-members:
47+
:show-inheritance:

0 commit comments

Comments
 (0)