deploy: 26d48f8

Author: tomschr

.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: 4f5ed08a0415aa14615a295880efe9da
+config: 1120aacda35146589fe823aaf1882c7e
 tags: 645f666f9bcd5a90fca523b33c5a78b7

_sources/developer/run-ipython.rst.txt

@@ -13,7 +13,6 @@ This is useful for experimenting with the project's code and for debugging.
 
 .. code-block:: shell-session
    :caption: Running IPython using |uv| with alias :ref:`uipython <devel-helpers>`
-   :name: sh-running-ipython
 
    uipython
 
@@ -26,4 +25,4 @@ After the IPython shell is loaded, you can use the normal import without changin
    [...]
    In [1]: from docbuild.cli.context import Doctype
    In [2]: Doctype
-   Out[2]: docbuild.models.doctype.Doctype
+   Out[2]: docbuild.models.doctype.Doctype

_sources/glossary.rst.txt

@@ -1,7 +1,7 @@
 Glossary
 ========
 
-:term:`A <ADoc>` | :term:`C <Changelog>` | :term:`D <DAPS>` | :term:`G <GIL>` | :term:`I <IPython>` | :term:`L <Lifecycle>` | :term:`M <Module>` | :term:`O <Option>` | :term:`P <Package>` | :term:`R <Ruff>` | :term:`S <SemVer>` | :term:`U <UV>` | :term:`V <VENV>` | :term:`X <XML>`
+:term:`A <ADoc>` | :term:`C <Changelog>` | :term:`D <DAPS>` | :term:`G <GIL>` | :term:`I <IPython>` | :term:`L <Lifecycle>` | :term:`M <Module>` | :term:`O <Option>` | :term:`P <Package>` | :term:`R <RNC>` | :term:`S <SemVer>` | :term:`U <UV>` | :term:`V <VENV>` | :term:`X <XML>`
 
 For Python specific terms, look into:
 
@@ -12,6 +12,9 @@ For Python specific terms, look into:
 .. glossary::
    :sorted:
 
+   ACID
+      A set of properties that guarantee reliable processing of database transactions, ensuring that they are *Atomic*, *Consistent*, *Isolated*, and *Durable*.
+
    ADoc
    ASCIIDoc
       A lightweight markup language, similar to Markdown, but with a more powerful and extensive syntax designed for writing complex technical documentation, articles, and books.
@@ -151,6 +154,16 @@ For Python specific terms, look into:
 
       See https://pytest.org
 
+   RELAX NG
+   RNC
+   RNG
+      A schema language for XML used to define and validate the structure
+      and content of XML documents.
+      RNC is the compact syntax of RELAX NG, while RNG is the XML syntax.
+      Both are equivalent in terms of expressiveness.
+
+      See https://relaxng.org/
+
    Ruff
       A fast extensible linter and code formatter to improve code qualitiy
       and enforce style guidelines.

_sources/reference/_autoapi/docbuild/models/config/env/EnvPathsConfig.rst.txt

@@ -55,7 +55,7 @@ docbuild.models.config.env.EnvPathsConfig
 
 
    .. py:attribute:: repo_dir
-      :type:  pathlib.Path
+      :type:  docbuild.models.path.EnsureWritableDirectory
       :value: None
 
 
@@ -64,7 +64,7 @@ docbuild.models.config.env.EnvPathsConfig
 
 
    .. py:attribute:: tmp_repo_dir
-      :type:  pathlib.Path
+      :type:  docbuild.models.path.EnsureWritableDirectory
       :value: None
 
 
@@ -73,7 +73,7 @@ docbuild.models.config.env.EnvPathsConfig
 
 
    .. py:attribute:: base_cache_dir
-      :type:  pathlib.Path
+      :type:  docbuild.models.path.EnsureWritableDirectory
       :value: None
 
 
@@ -82,7 +82,7 @@ docbuild.models.config.env.EnvPathsConfig
 
 
    .. py:attribute:: base_server_cache_dir
-      :type:  pathlib.Path
+      :type:  docbuild.models.path.EnsureWritableDirectory
       :value: None
 
 
@@ -91,7 +91,7 @@ docbuild.models.config.env.EnvPathsConfig
 
 
    .. py:attribute:: meta_cache_dir
-      :type:  pathlib.Path
+      :type:  docbuild.models.path.EnsureWritableDirectory
       :value: None
 
 

_sources/reference/_autoapi/docbuild/models/config_model/index.rst.txt

@@ -20,8 +20,8 @@ docbuild.models.language.LanguageCode
       :value: None
 
 
-      The natural language in the format ll-cc, where 'll' is the
-      language and 'cc' the country.
+      The natural language in the format ``ll-cc``, where ``ll`` is the
+      language and ``cc`` the country.
 
 
 
@@ -41,43 +41,46 @@ docbuild.models.language.LanguageCode
 
    .. py:method:: __str__() -> str
 
-      Implement str(self).
+      Implement ``str(self)``.
 
 
 
    .. py:method:: __repr__() -> str
 
-      Implement repr(self).
+      Implement ``repr(self)``.
 
 
 
    .. py:method:: __eq__(other: object|str|LanguageCode) -> bool
 
-      Implement self == other.
+      Implement ``self == other``.
 
       The comparison does NOT break the principle of equality:
-      * Reflexive: a == b
-      * Symmetric: a == b <=> b == a
-      * Transitive: if a == b and b == c, then a == c
 
-      If you need to check for wildcard logic, use matches()
+      *  Reflexive: a == b
+      *  Symmetric: a == b <=> b == a
+      *  Transitive: if a == b and b == c, then a == c
+
+      If you need to check for wildcard logic, use
+      :meth:`~docbuild.models.language.LanguageCode.matches()` instead.
 
 
 
    .. py:method:: __lt__(other: object|str|LanguageCode) -> bool
 
-      Implement self < other.
+      Implement ``self < other``.
 
       Special properties:
-      - "*" is always the "smallest" language
-      - If self contains "*" and the other not, return True
-      - If self and the other contains "*", return False
+
+      *  "*" is always the "smallest" language
+      *  If self contains "*" and the other not, return True
+      *  If self and the other contains "*", return False
 
 
 
    .. py:method:: __hash__() -> int
 
-      Implement hash(self).
+      Implement ``hash(self)``.
 
       For using 'in sets' or as dict keys
 

_sources/reference/_autoapi/docbuild/models/language/LanguageCode.rst.txt

@@ -11,3 +11,11 @@ docbuild.models.manifest.Archive
 
    Represents an archive (e.g., a ZIP file) for a product/docset.
 
+   .. code-block:: json
+
+       {
+           "lang": "en-us",
+           "default": true,
+           "zip": "/en-us/sles/16.0/sles-16.0-en-us.zip"
+       }
+

_sources/reference/_autoapi/docbuild/models/manifest/Archive.rst.txt

@@ -11,3 +11,17 @@ docbuild.models.manifest.Category
 
    Represents a category for a product/docset.
 
+   .. code-block:: json
+
+       {
+           "categoryId": "about",
+           "rank": 1,
+           "translations": [
+               {
+                   "lang": "en-us",
+                   "default": true,
+                   "title": "About"
+               }
+           ]
+       }
+

_sources/reference/_autoapi/docbuild/models/manifest/Category.rst.txt

@@ -11,3 +11,11 @@ docbuild.models.manifest.CategoryTranslation
 
    Represents a translation for a category title.
 
+   .. code-block:: json
+
+       {
+           "lang": "en-us",
+           "default": true,
+           "title": "About"
+       }
+

_sources/reference/_autoapi/docbuild/models/manifest/CategoryTranslation.rst.txt

@@ -11,3 +11,11 @@ docbuild.models.manifest.Description
 
    Represents a description for a product/docset.
 
+   .. code-block:: json
+
+       {
+           "lang": "en-us",
+           "default": true,
+           "description": "<p>The English description for a product.</p>"
+       }
+