Deploy preview for PR 93 🛫

pr-preview/pr-93/.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: fcb2a1cc224118c6aaa27ee9a20e9281
+tags: d77d1c0d9ca2f4c8421862c7c5a0d620

pr-preview/pr-93/_sources/_pending_changes.rst.txt

@@ -0,0 +1,9 @@
+:orphan:
+
+.. Syntax check the changelog fragments
+
+.. toctree::
+   :hidden:
+   :glob:
+
+   changelog.d/*

pr-preview/pr-93/_sources/api/cli/index.rst.txt

@@ -0,0 +1,18 @@
+venvstacks.cli
+==============
+
+.. meta::
+   :og:title: venvstacks.cli API - venvstacks Documentation
+   :og:type: website
+   :og:url: https://venvstacks.lmstudio.ai/api/cli/
+   :og:description: venvstacks.cli Python API - venvstacks Documentation
+
+.. warning::
+
+   The Python API is *NOT YET STABLE*.
+   Function, class, and method names may change between releases
+   without any deprecation period.
+
+.. automodule:: venvstacks.cli
+
+   .. autofunction:: main

pr-preview/pr-93/_sources/api/index.rst.txt

@@ -0,0 +1,25 @@
+----------
+Python API
+----------
+
+.. meta::
+   :og:title: venvstacks API - venvstacks Documentation
+   :og:type: website
+   :og:url: https://venvstacks.lmstudio.ai/api/
+   :og:description: venvstacks Python API - venvstacks Documentation
+
+.. warning::
+
+   The Python API is *NOT YET STABLE*.
+   Function, class, and method names may change between releases
+   without any deprecation period.
+
+.. automodule:: venvstacks
+
+   .. rubric:: Modules
+
+   .. toctree::
+
+      cli/index
+      pack_venv/index
+      stacks/index

pr-preview/pr-93/_sources/api/pack_venv/index.rst.txt

@@ -0,0 +1,21 @@
+venvstacks.pack\_venv
+=====================
+
+.. meta::
+   :og:title: venvstacks.pack_venv API - venvstacks Documentation
+   :og:type: website
+   :og:url: https://venvstacks.lmstudio.ai/api/pack_venv/
+   :og:description: venvstacks.pack_venv Python API - venvstacks Documentation
+
+.. warning::
+
+   The Python API is *NOT YET STABLE*.
+   Function, class, and method names may change between releases
+   without any deprecation period.
+
+.. automodule:: venvstacks.pack_venv
+
+   .. autofunction:: convert_symlinks
+   .. autofunction:: create_archive
+   .. autofunction:: export_venv
+   .. autofunction:: get_archive_path

pr-preview/pr-93/_sources/api/stacks/index.rst.txt

@@ -0,0 +1,118 @@
+venvstacks.stacks
+=================
+
+.. meta::
+   :og:title: venvstacks.stacks API - venvstacks Documentation
+   :og:type: website
+   :og:url: https://venvstacks.lmstudio.ai/api/stacks/
+   :og:description: venvstacks.stacks Python API - venvstacks Documentation
+
+.. TODO: Replace the autosummary tables with:
+           * inline docs for the high level interface and the exceptions
+           * a stacks/metadata-details/ page
+           * a stacks/archive-publication/ page
+           * a stacks/local-exports/ page
+           * a stacks/layer-specifications/ page
+           * a stacks/layer-build-environments/ page
+           * a stacks/build-configuration/ page
+
+         Dedicated pages correspond to the sections below (except as noted).
+         Page names contain hyphens to ensure they're not valid submodule names.
+
+.. warning::
+
+   The Python API is *NOT YET STABLE*.
+   Function, class, and method names may change between releases
+   without any deprecation period.
+
+.. automodule:: venvstacks.stacks
+
+   .. rubric:: High Level Interface
+
+   .. autosummary::
+      :toctree:
+      :nosignatures:
+
+      StackSpec
+      BuildEnvironment
+
+   .. rubric:: Layer Metadata Components
+
+   .. autosummary::
+      :toctree:
+      :nosignatures:
+
+      LayerCategories
+      LayerSpecMetadata
+      LayerVariants
+      TargetPlatform
+      TargetPlatforms
+
+   .. rubric:: Archive Publishing Results
+
+   .. autosummary::
+      :toctree:
+      :nosignatures:
+
+      ArchiveBuildMetadata
+      ArchiveBuildRequest
+      ArchiveHashes
+      ArchiveMetadata
+      PublishedArchivePaths
+      StackPublishingRequest
+      StackPublishingResult
+
+   .. rubric:: Layer Export Results
+
+   .. autosummary::
+      :toctree:
+      :nosignatures:
+
+      LayerExportRequest
+      ExportMetadata
+      ExportedEnvironmentPaths
+      StackExportRequest
+
+   .. rubric:: Layer Specifications
+
+   .. autosummary::
+      :toctree:
+      :nosignatures:
+
+      LayerSpecBase
+      RuntimeSpec
+      LayeredSpecBase
+      FrameworkSpec
+      ApplicationSpec
+
+   .. rubric:: Layer Build Environments
+
+   .. autosummary::
+      :toctree:
+      :nosignatures:
+
+      LayerEnvBase
+      RuntimeEnv
+      LayeredEnvBase
+      FrameworkEnv
+      ApplicationEnv
+      EnvironmentLock
+      EnvironmentLockMetadata
+
+   .. rubric:: Build Process Configuration
+
+   .. autosummary::
+      :toctree:
+      :nosignatures:
+
+      PackageIndexConfig
+
+   .. rubric:: Exceptions
+
+   .. autosummary::
+      :toctree:
+      :nosignatures:
+
+      BuildEnvError
+      EnvStackError
+      LayerSpecError

pr-preview/pr-93/_sources/api/stacks/venvstacks.stacks.ApplicationEnv.rst.txt

@@ -0,0 +1,38 @@
+venvstacks.stacks.ApplicationEnv
+================================
+
+.. currentmodule:: venvstacks.stacks
+
+.. autoclass:: ApplicationEnv
+
+   .. rubric:: Attributes
+
+   .. autosummary::
+
+      ~FrameworkEnv.base_runtime
+      ~ApplicationEnv.category
+      ~ApplicationEnv.env_name
+      ~ApplicationEnv.env_spec
+      ~ApplicationEnv.install_target
+      ~ApplicationEnv.kind
+      ~ApplicationEnv.launch_module_name
+      ~ApplicationEnv.linked_constraints_paths
+      ~ApplicationEnv.linked_frameworks
+      ~ApplicationEnv.want_build
+      ~ApplicationEnv.want_lock
+      ~ApplicationEnv.want_publish
+      ~ApplicationEnv.was_built
+      ~ApplicationEnv.was_created
+      ~ApplicationEnv.build_path
+      ~ApplicationEnv.requirements_path
+      ~ApplicationEnv.index_config
+      ~ApplicationEnv.env_path
+      ~ApplicationEnv.pylib_path
+      ~ApplicationEnv.dynlib_path
+      ~ApplicationEnv.executables_path
+      ~ApplicationEnv.python_path
+      ~ApplicationEnv.env_lock
+      ~ApplicationEnv.base_python_path
+      ~ApplicationEnv.tools_python_path
+      ~ApplicationEnv.py_version
+

pr-preview/pr-93/_sources/api/stacks/venvstacks.stacks.ApplicationSpec.rst.txt

@@ -0,0 +1,23 @@
+venvstacks.stacks.ApplicationSpec
+=================================
+
+.. currentmodule:: venvstacks.stacks
+
+.. autoclass:: ApplicationSpec
+
+   .. rubric:: Attributes
+
+   .. autosummary::
+
+      ~ApplicationSpec.ENV_PREFIX
+      ~ApplicationSpec.category
+      ~ApplicationSpec.env_name
+      ~ApplicationSpec.kind
+      ~ApplicationSpec.launch_module_path
+      ~ApplicationSpec.frameworks
+      ~ApplicationSpec.runtime
+      ~ApplicationSpec.name
+      ~ApplicationSpec.versioned
+      ~ApplicationSpec.requirements
+      ~ApplicationSpec.platforms
+

pr-preview/pr-93/_sources/api/stacks/venvstacks.stacks.ArchiveBuildMetadata.rst.txt

@@ -0,0 +1,24 @@
+venvstacks.stacks.ArchiveBuildMetadata
+======================================
+
+.. currentmodule:: venvstacks.stacks
+
+.. autoclass:: ArchiveBuildMetadata
+
+   .. rubric:: Attributes
+
+   .. autosummary::
+
+      ~ArchiveBuildMetadata.layer_name
+      ~ArchiveBuildMetadata.install_target
+      ~ArchiveBuildMetadata.requirements_hash
+      ~ArchiveBuildMetadata.lock_version
+      ~ArchiveBuildMetadata.locked_at
+      ~ArchiveBuildMetadata.runtime_layer
+      ~ArchiveBuildMetadata.required_layers
+      ~ArchiveBuildMetadata.app_launch_module
+      ~ArchiveBuildMetadata.app_launch_module_hash
+      ~ArchiveBuildMetadata.archive_build
+      ~ArchiveBuildMetadata.archive_name
+      ~ArchiveBuildMetadata.target_platform
+

pr-preview/pr-93/_sources/api/stacks/venvstacks.stacks.ArchiveBuildRequest.rst.txt

@@ -0,0 +1,25 @@
+venvstacks.stacks.ArchiveBuildRequest
+=====================================
+
+.. currentmodule:: venvstacks.stacks
+
+.. autoclass:: ArchiveBuildRequest
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~ArchiveBuildRequest.create_archive
+      ~ArchiveBuildRequest.define_build
+
+   .. rubric:: Attributes
+
+   .. autosummary::
+
+      ~ArchiveBuildRequest.env_name
+      ~ArchiveBuildRequest.env_lock
+      ~ArchiveBuildRequest.archive_base_path
+      ~ArchiveBuildRequest.build_metadata
+      ~ArchiveBuildRequest.needs_build
+

pr-preview/pr-93/_sources/api/stacks/venvstacks.stacks.ArchiveHashes.rst.txt

@@ -0,0 +1,13 @@
+venvstacks.stacks.ArchiveHashes
+===============================
+
+.. currentmodule:: venvstacks.stacks
+
+.. autoclass:: ArchiveHashes
+
+   .. rubric:: Attributes
+
+   .. autosummary::
+
+      ~ArchiveHashes.sha256
+

pr-preview/pr-93/_sources/api/stacks/venvstacks.stacks.ArchiveMetadata.rst.txt

@@ -0,0 +1,26 @@
+venvstacks.stacks.ArchiveMetadata
+=================================
+
+.. currentmodule:: venvstacks.stacks
+
+.. autoclass:: ArchiveMetadata
+
+   .. rubric:: Attributes
+
+   .. autosummary::
+
+      ~ArchiveMetadata.layer_name
+      ~ArchiveMetadata.install_target
+      ~ArchiveMetadata.requirements_hash
+      ~ArchiveMetadata.lock_version
+      ~ArchiveMetadata.locked_at
+      ~ArchiveMetadata.runtime_layer
+      ~ArchiveMetadata.required_layers
+      ~ArchiveMetadata.app_launch_module
+      ~ArchiveMetadata.app_launch_module_hash
+      ~ArchiveMetadata.archive_build
+      ~ArchiveMetadata.archive_name
+      ~ArchiveMetadata.target_platform
+      ~ArchiveMetadata.archive_size
+      ~ArchiveMetadata.archive_hashes
+

pr-preview/pr-93/_sources/api/stacks/venvstacks.stacks.BuildEnvError.rst.txt

@@ -0,0 +1,6 @@
+venvstacks.stacks.BuildEnvError
+===============================
+
+.. currentmodule:: venvstacks.stacks
+
+.. autoexception:: BuildEnvError