Deploying to gh-pages from @ 7877f74 🚀

lmstudio-ai · Nov 12, 2024 · 5d6d086 · 5d6d086
1 parent 9e75274
commit 5d6d086
Show file tree

Hide file tree

Showing 86 changed files with 3,377 additions and 580 deletions.
diff --git a/.buildinfo b/.buildinfo
@@ -1,4 +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: de7f721c757d20fd25f05899fb32b97e
+config: 5de777e7786b9c0cdc82be54d483ddbc
 tags: d77d1c0d9ca2f4c8421862c7c5a0d620
diff --git a/.doctrees/api/cli/index.doctree b/.doctrees/api/cli/index.doctree
diff --git a/.doctrees/api/index.doctree b/.doctrees/api/index.doctree
diff --git a/.doctrees/api/pack_venv/index.doctree b/.doctrees/api/pack_venv/index.doctree
diff --git a/.doctrees/api/stacks/index.doctree b/.doctrees/api/stacks/index.doctree
diff --git a/.doctrees/changelog.d/20241105_141935_ncoghlan_more_resilient_postinstall.doctree b/.doctrees/changelog.d/20241105_141935_ncoghlan_more_resilient_postinstall.doctree
diff --git a/.doctrees/changelog.d/20241108_162952_ncoghlan_fix_automatic_layer_versioning.doctree b/.doctrees/changelog.d/20241108_162952_ncoghlan_fix_automatic_layer_versioning.doctree
diff --git a/.doctrees/changelog.d/20241108_215625_ncoghlan_enable_docstring_style_checks.doctree b/.doctrees/changelog.d/20241108_215625_ncoghlan_enable_docstring_style_checks.doctree
diff --git a/.doctrees/changelog.d/20241111_104113_ncoghlan_add_stack_format_docs.doctree b/.doctrees/changelog.d/20241111_104113_ncoghlan_add_stack_format_docs.doctree
diff --git a/.doctrees/changelog.doctree b/.doctrees/changelog.doctree
diff --git a/.doctrees/design.doctree b/.doctrees/design.doctree
diff --git a/.doctrees/development/index.doctree b/.doctrees/development/index.doctree
diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle
diff --git a/.doctrees/file-formats.doctree b/.doctrees/file-formats.doctree
diff --git a/.doctrees/glossary.doctree b/.doctrees/glossary.doctree
diff --git a/.doctrees/index.doctree b/.doctrees/index.doctree
diff --git a/.doctrees/overview.doctree b/.doctrees/overview.doctree
diff --git a/_sources/api/cli/index.rst.txt b/_sources/api/cli/index.rst.txt
@@ -1,6 +1,12 @@
 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*.

diff --git a/_sources/api/index.rst.txt b/_sources/api/index.rst.txt
@@ -2,6 +2,12 @@
 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*.

diff --git a/_sources/api/pack_venv/index.rst.txt b/_sources/api/pack_venv/index.rst.txt
@@ -1,6 +1,12 @@
 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*.

diff --git a/_sources/api/stacks/index.rst.txt b/_sources/api/stacks/index.rst.txt
@@ -1,6 +1,24 @@
 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*.

diff --git a/_sources/changelog.d/20241105_141935_ncoghlan_more_resilient_postinstall.rst.txt b/_sources/changelog.d/20241105_141935_ncoghlan_more_resilient_postinstall.rst.txt
@@ -0,0 +1,7 @@
+Fixed
+-----
+
+- Post-installation scripts for layered environments now work
+  correctly even when run with a Python installation other
+  than the expected base runtime (resolved in :issue:`66`)
+
diff --git a/...ces/changelog.d/20241108_162952_ncoghlan_fix_automatic_layer_versioning.rst.txt b/...ces/changelog.d/20241108_162952_ncoghlan_fix_automatic_layer_versioning.rst.txt
@@ -0,0 +1,9 @@
+Added
+-----
+
+- Setting ``versioned = True`` in a layer definition will append a
+  lock version number to the layer name that automatically increments
+  each time the locked requirements change for that layer (``layer@1``,
+  ``layer@2``, etc). Layer dependency declarations and build environments,
+  use the unversioned name, but deployed environments and their metadata
+  will use the versioned name (implemented in :issue:`24`).
diff --git a/...rces/changelog.d/20241108_215625_ncoghlan_enable_docstring_style_checks.rst.txt b/...rces/changelog.d/20241108_215625_ncoghlan_enable_docstring_style_checks.rst.txt
@@ -0,0 +1,11 @@
+Changed
+-------
+
+- Renamed :class:`!EnvironmentExportRequest` to :class:`LayerExportRequest` (part of :issue:`33`).
+- Exposed :class:`LayerSpecBase`, :class:`LayeredSpecBase` as public classes (part of :issue:`33`).
+- Exposed :class:`LayerEnvBase`, :class:`LayeredEnvBase` as public classes (part of :issue:`33`).
+- Added leading underscores to several private functions and methods (part of :issue:`33`).
+- Added docstrings to all remaining public functions and methods (part of :issue:`33`).
+- Enabled rendered previews for documentation PRs (requested in :issue:`43`).
+- Enabled link validity checks when rendering documentation (requested in :issue:`62`).
+
diff --git a/_sources/changelog.d/20241111_104113_ncoghlan_add_stack_format_docs.rst.txt b/_sources/changelog.d/20241111_104113_ncoghlan_add_stack_format_docs.rst.txt
@@ -0,0 +1,5 @@
+Added
+-----
+
+- Added documentation for the :ref:`stack-specification-format`.
+
diff --git a/_sources/changelog.rst.txt b/_sources/changelog.rst.txt
@@ -1 +1,31 @@
+.. _changelog:
+
+---------
+Changelog
+---------
+
+.. meta::
+   :og:title: venvstacks Changelog - venvstacks Documentation
+   :og:type: website
+   :og:url: https://venvstacks.lmstudio.ai/changelog/
+   :og:description: venvstacks Changelog - venvstacks Documentation
+
+.. note::
+
+   Until the Python API has stabilised, ``venvstacks`` is using
+   `ZeroVer <https://0ver.org/>`__ (starting from 0.1.0).
+
+   Refer to :ref:`version-numbering` for additional details
+   on the way releases are versioned.
+
+.. Syntax check the changelog fragments
+
+.. toctree::
+   :hidden:
+   :glob:
+
+   changelog.d/*
+
+.. Include the scriv-generated changelog details
+
 .. include:: ../CHANGELOG.rst
diff --git a/_sources/design.rst.txt b/_sources/design.rst.txt
@@ -2,6 +2,12 @@
 Design Discussion
 -----------------
 
+.. meta::
+   :og:title: venvstacks Design - venvstacks Documentation
+   :og:type: website
+   :og:url: https://venvstacks.lmstudio.ai/design/
+   :og:description: venvstacks Design Discussion - venvstacks Documentation
+
 Project
 =======
 

diff --git a/_sources/development/index.rst.txt b/_sources/development/index.rst.txt
@@ -4,6 +4,12 @@
 Development
 -----------
 
+.. meta::
+   :og:title: venvstacks Development - venvstacks Documentation
+   :og:type: website
+   :og:url: https://venvstacks.lmstudio.ai/development/
+   :og:description: venvstacks Developer Guide - venvstacks Documentation
+
 
 Getting Started
 ===============
@@ -12,7 +18,8 @@ Getting Started
 
 This document aims to get you setup to work on venvstacks and to act as a guide
 and reference to the development setup. If you face any issues during this
-process, please `open an issue`_ about it on the issue tracker.
+process, please :issue:`open an issue <new?title=Trouble+with+development+environment>`
+about it on the issue tracker.
 
 
 Get the source code
@@ -279,7 +286,6 @@ After release:
 * Bump the version in ``pyproject.toml`` and add a ``.dev0`` suffix
 
 .. _`Getting Started`: https://pip.pypa.io/en/stable/development/getting-started/
-.. _`open an issue`: https://github.com/lmstudio-ai/venvstacks/issues/new?title=Trouble+with+development+environment
 .. _`rich CLI`: https://docs.pytest.org/en/stable/how-to/usage.html#specifying-which-tests-to-run
 .. _`GitHub`: https://github.com/lmstudio-ai/venvstacks
 .. _`testing README file`: https://github.com/lmstudio-ai/venvstacks/blob/main/tests/README.md