Skip to content

Commit fc68c3b

Browse files
ncoghlanncoghlan
authored
Initial restructuring of API docs (#54)
Also appropriately marks some symbols that shouldn't be accessed externally as private. Initial steps towards to addressing #33
1 parent ff058d1 commit fc68c3b

File tree

45 files changed

+162
-173
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+162
-173
lines changed

‎docs/api/cli/index.rst‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
venvstacks.cli
2+
==============
3+
4+
.. warning::
5+
6+
The Python API is *NOT YET STABLE*.
7+
Function, class, and method names may change between releases
8+
without any deprecation period.
9+
10+
.. automodule:: venvstacks.cli
11+
12+
.. autofunction:: main

‎docs/api/index.rst‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,8 @@ Python API
1212

1313
.. rubric:: Modules
1414

15-
.. autosummary::
16-
:toctree:
15+
.. toctree::
1716

18-
cli
19-
pack_venv
20-
stacks
17+
cli/index
18+
pack_venv/index
19+
stacks/index

‎docs/api/pack_venv/index.rst‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
venvstacks.pack\_venv
2+
=====================
3+
4+
.. warning::
5+
6+
The Python API is *NOT YET STABLE*.
7+
Function, class, and method names may change between releases
8+
without any deprecation period.
9+
10+
.. automodule:: venvstacks.pack_venv
11+
12+
.. autofunction:: convert_symlinks
13+
.. autofunction:: create_archive
14+
.. autofunction:: export_venv
15+
.. autofunction:: get_archive_path

‎docs/api/venvstacks.stacks.rst‎ renamed to ‎docs/api/stacks/index.rst‎

Lines changed: 68 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,95 @@
11
venvstacks.stacks
22
=================
33

4+
.. warning::
5+
6+
The Python API is *NOT YET STABLE*.
7+
Function, class, and method names may change between releases
8+
without any deprecation period.
9+
410
.. automodule:: venvstacks.stacks
511

12+
.. rubric:: High Level Interface
613

7-
.. rubric:: Classes
14+
.. autosummary::
15+
:toctree:
16+
:nosignatures:
17+
18+
StackSpec
19+
BuildEnvironment
20+
21+
.. rubric:: Layer Metadata Components
822

923
.. autosummary::
1024
:toctree:
25+
:nosignatures:
26+
27+
LayerCategories
28+
LayerSpecMetadata
29+
LayerVariants
30+
TargetPlatform
31+
TargetPlatforms
32+
33+
.. rubric:: Archive Publishing Results
34+
35+
.. autosummary::
36+
:toctree:
37+
:nosignatures:
1138

12-
ApplicationEnv
13-
ApplicationSpec
1439
ArchiveBuildMetadata
1540
ArchiveBuildRequest
1641
ArchiveHashes
1742
ArchiveMetadata
18-
BuildEnvironment
43+
PublishedArchivePaths
44+
StackPublishingRequest
45+
StackPublishingResult
46+
47+
.. rubric:: Layer Export Results
48+
49+
.. autosummary::
50+
:toctree:
51+
:nosignatures:
52+
1953
EnvironmentExportRequest
20-
EnvironmentLock
21-
EnvironmentLockMetadata
2254
ExportMetadata
2355
ExportedEnvironmentPaths
24-
FrameworkEnv
56+
StackExportRequest
57+
58+
.. rubric:: Layer Specifications
59+
60+
.. autosummary::
61+
:toctree:
62+
:nosignatures:
63+
64+
RuntimeSpec
2565
FrameworkSpec
26-
PackageIndexConfig
27-
LayerCategories
28-
LayerSpecMetadata
29-
LayerVariants
30-
PublishedArchivePaths
66+
ApplicationSpec
67+
68+
.. rubric:: Layer Build Environments
69+
70+
.. autosummary::
71+
:toctree:
72+
:nosignatures:
73+
74+
ApplicationEnv
75+
FrameworkEnv
3176
RuntimeEnv
32-
RuntimeSpec
33-
StackExportRequest
34-
StackPublishingRequest
35-
StackPublishingResult
36-
StackSpec
37-
TargetPlatform
38-
TargetPlatforms
77+
EnvironmentLock
78+
EnvironmentLockMetadata
79+
80+
.. rubric:: Build Process Configuration
81+
82+
.. autosummary::
83+
:toctree:
84+
:nosignatures:
85+
86+
PackageIndexConfig
3987

4088
.. rubric:: Exceptions
4189

4290
.. autosummary::
4391
:toctree:
92+
:nosignatures:
4493

4594
BuildEnvError
4695
EnvStackError

‎docs/api/venvstacks.stacks.ApplicationEnv.rst‎ renamed to ‎docs/api/stacks/venvstacks.stacks.ApplicationEnv.rst‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,6 @@ venvstacks.stacks.ApplicationEnv
55

66
.. autoclass:: ApplicationEnv
77

8-
9-
.. automethod:: __init__
10-
118
.. rubric:: Methods
129

1310
.. autosummary::

‎docs/api/venvstacks.stacks.ApplicationSpec.rst‎ renamed to ‎docs/api/stacks/venvstacks.stacks.ApplicationSpec.rst‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,6 @@ venvstacks.stacks.ApplicationSpec
66
.. autoclass:: ApplicationSpec
77

88

9-
.. automethod:: __init__
10-
11-
129
.. rubric:: Methods
1310

1411
.. autosummary::

‎docs/api/venvstacks.stacks.ArchiveBuildMetadata.rst‎ renamed to ‎docs/api/stacks/venvstacks.stacks.ArchiveBuildMetadata.rst‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,6 @@ venvstacks.stacks.ArchiveBuildMetadata
55

66
.. autoclass:: ArchiveBuildMetadata
77

8-
9-
.. automethod:: __init__
10-
118
.. rubric:: Attributes
129

1310
.. autosummary::

‎docs/api/venvstacks.stacks.ArchiveBuildRequest.rst‎ renamed to ‎docs/api/stacks/venvstacks.stacks.ArchiveBuildRequest.rst‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,6 @@ venvstacks.stacks.ArchiveBuildRequest
66
.. autoclass:: ArchiveBuildRequest
77

88

9-
.. automethod:: __init__
10-
11-
129
.. rubric:: Methods
1310

1411
.. autosummary::

‎docs/api/venvstacks.stacks.ArchiveHashes.rst‎ renamed to ‎docs/api/stacks/venvstacks.stacks.ArchiveHashes.rst‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,6 @@ venvstacks.stacks.ArchiveHashes
55

66
.. autoclass:: ArchiveHashes
77

8-
.. automethod:: __init__
9-
108
.. rubric:: Attributes
119

1210
.. autosummary::

‎docs/api/venvstacks.stacks.ArchiveMetadata.rst‎ renamed to ‎docs/api/stacks/venvstacks.stacks.ArchiveMetadata.rst‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,6 @@ venvstacks.stacks.ArchiveMetadata
55

66
.. autoclass:: ArchiveMetadata
77

8-
.. automethod:: __init__
9-
108
.. rubric:: Attributes
119

1210
.. autosummary::

0 commit comments

Comments
 (0)