deploy: efaca8c

Author: sushant-suse

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

@@ -17,3 +17,12 @@ docbuild.models.config.env.EnvBuildContainer
       Configuration for the model, should be a dictionary conforming to [`ConfigDict`][pydantic.config.ConfigDict].
 
 
+
+   .. py:attribute:: container
+      :type:  str
+      :value: None
+
+
+      The container image used for the build environment.
+
+

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

@@ -17,3 +17,21 @@ docbuild.models.config.env.EnvBuildDaps
       Configuration for the model, should be a dictionary conforming to [`ConfigDict`][pydantic.config.ConfigDict].
 
 
+
+   .. py:attribute:: command
+      :type:  str
+      :value: None
+
+
+      The base command used for DAPS execution.
+
+
+
+   .. py:attribute:: meta
+      :type:  str
+      :value: None
+
+
+      The command used to extract DAPS metadata.
+
+

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

@@ -32,6 +32,6 @@ docbuild.models.config.env.EnvTargetPaths
       :value: None
 
 
-      Directory for backups.
+      Local directory for storing build backups before deployment.
 
 

_sources/user/config.rst.txt

@@ -32,3 +32,15 @@ To deal with different environments without having to type the full command each
    alias docbuild-prod='docbuild --env-config env.production.toml'
    alias docbuild-test='docbuild --env-config env.testing.toml'
    alias docbuild-dev='docbuild --env-config env.devel.toml'
+
+Viewing the Environment Configuration
+------------------------------------
+
+To see how ``docbuild`` interprets your environment configuration, use the ``config env`` subcommand. This is particularly useful for verifying that all placeholders (like ``{{product}}`` or ``{{lang}}``) have been correctly resolved into absolute paths.
+
+.. code-block:: shell-session
+   :caption: Displaying the resolved environment configuration
+
+   docbuild config env
+
+If the configuration contains errors—such as missing mandatory keys or invalid data types—the command will output a validation error detailing what needs to be fixed.

genindex.html

@@ -759,10 +759,10 @@ <h2 id="C">C</h2>
 </li>
       <li><a href="reference/_autoapi/docbuild/config/xml/checks/index.html#docbuild.config.xml.checks.check_subdeliverable_in_deliverable">check_subdeliverable_in_deliverable() (in module docbuild.config.xml.checks)</a>
 </li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="reference/_autoapi/docbuild/config/xml/checks/index.html#docbuild.config.xml.checks.check_translation_deliverables">check_translation_deliverables() (in module docbuild.config.xml.checks)</a>
 </li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="reference/_autoapi/docbuild/config/xml/checks/index.html#docbuild.config.xml.checks.check_valid_languages">check_valid_languages() (in module docbuild.config.xml.checks)</a>
 </li>
       <li><a href="glossary.html#term-CI-CD"><strong>CI/CD</strong></a>
@@ -788,6 +788,8 @@ <h2 id="C">C</h2>
       <li><a href="reference/_autoapi/docbuild/models/manifest/Document.html#docbuild.models.manifest.Document.coerce_rank">coerce_rank() (docbuild.models.manifest.Document class method)</a>
 </li>
       <li><a href="reference/_autoapi/docbuild/cli/cmd_metadata/metaprocess/index.html#docbuild.cli.cmd_metadata.metaprocess.collect_files_flat">collect_files_flat() (in module docbuild.cli.cmd_metadata.metaprocess)</a>
+</li>
+      <li><a href="reference/_autoapi/docbuild/models/config/env/EnvBuildDaps.html#docbuild.models.config.env.EnvBuildDaps.command">command (docbuild.models.config.env.EnvBuildDaps attribute)</a>
 </li>
       <li><a href="glossary.html#term-Concurrency"><strong>Concurrency</strong></a>
 </li>
@@ -800,6 +802,8 @@ <h2 id="C">C</h2>
       <li><a href="reference/_autoapi/docbuild/constants/index.html#docbuild.constants.CONFIG_PATHS">CONFIG_PATHS (in module docbuild.constants)</a>
 </li>
       <li><a href="reference/_autoapi/docbuild/config/app/index.html#docbuild.config.app.ConfigValue">ConfigValue (in module docbuild.config.app)</a>
+</li>
+      <li><a href="reference/_autoapi/docbuild/models/config/env/EnvBuildContainer.html#docbuild.models.config.env.EnvBuildContainer.container">container (docbuild.models.config.env.EnvBuildContainer attribute)</a>
 </li>
       <li><a href="reference/_autoapi/docbuild/utils/convert/index.html#docbuild.utils.convert.convert2bool">convert2bool() (in module docbuild.utils.convert)</a>
 </li>
@@ -1615,8 +1619,12 @@ <h2 id="M">M</h2>
 </li>
       <li><a href="reference/_autoapi/docbuild/utils/merge/index.html#docbuild.utils.merge.merge_doctypes">merge_doctypes() (in module docbuild.utils.merge)</a>
 </li>
-      <li><a href="reference/_autoapi/docbuild/models/deliverable/Deliverable.html#docbuild.models.deliverable.Deliverable.meta">meta (docbuild.models.deliverable.Deliverable property)</a>
+      <li><a href="reference/_autoapi/docbuild/models/config/env/EnvBuildDaps.html#docbuild.models.config.env.EnvBuildDaps.meta">meta (docbuild.models.config.env.EnvBuildDaps attribute)</a>
+
+      <ul>
+        <li><a href="reference/_autoapi/docbuild/models/deliverable/Deliverable.html#docbuild.models.deliverable.Deliverable.meta">(docbuild.models.deliverable.Deliverable property)</a>
 </li>
+      </ul></li>
       <li><a href="reference/_autoapi/docbuild/models/config/env/EnvPathsConfig.html#docbuild.models.config.env.EnvPathsConfig.meta_cache_dir">meta_cache_dir (docbuild.models.config.env.EnvPathsConfig attribute)</a>
 </li>
       <li><a href="reference/_autoapi/docbuild/cli/cmd_metadata/index.html#docbuild.cli.cmd_metadata.metadata">metadata() (in module docbuild.cli.cmd_metadata)</a>

index.html

@@ -422,6 +422,7 @@ <h1>docbuild Documentation 0.15.0<a class="headerlink" href="#project-documentat
 <li class="toctree-l1"><a class="reference internal" href="user/index.html">User Guide</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="user/install.html">Installing docbuild</a></li>
 <li class="toctree-l2"><a class="reference internal" href="user/config.html">Configuring the Tool</a></li>
+<li class="toctree-l2"><a class="reference internal" href="user/config.html#viewing-the-environment-configuration">Viewing the Environment Configuration</a></li>
 <li class="toctree-l2"><a class="reference internal" href="user/run-docbuild.html">Running docbuild</a></li>
 <li class="toctree-l2"><a class="reference internal" href="user/config/index.html">Showing configuration</a></li>
 <li class="toctree-l2"><a class="reference internal" href="user/build.html">Building Deliverables</a></li>

objects.inv

@@ -623,6 +623,12 @@ <h1>docbuild.models.config.env.EnvBuildContainer<a class="headerlink" href="#doc
 <dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p>
 </dd></dl>
 
+<dl class="py attribute">
+<dt class="sig sig-object py" id="docbuild.models.config.env.EnvBuildContainer.container">
+<span class="sig-name descname"><span class="pre">container</span></span><span class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></span><a class="headerlink" href="#docbuild.models.config.env.EnvBuildContainer.container" title="Link to this definition">#</a></dt>
+<dd><p>The container image used for the build environment.</p>
+</dd></dl>
+
 </dd></dl>
 
 </section>
@@ -676,6 +682,7 @@ <h1>docbuild.models.config.env.EnvBuildContainer<a class="headerlink" href="#doc
     <ul class="visible nav section-nav flex-column">
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#docbuild.models.config.env.EnvBuildContainer"><code class="docutils literal notranslate"><span class="pre">docbuild.models.config.env.EnvBuildContainer</span></code></a><ul class="nav section-nav flex-column">
 <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#docbuild.models.config.env.EnvBuildContainer.model_config"><code class="docutils literal notranslate"><span class="pre">docbuild.models.config.env.EnvBuildContainer.model_config</span></code></a></li>
+<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#docbuild.models.config.env.EnvBuildContainer.container"><code class="docutils literal notranslate"><span class="pre">docbuild.models.config.env.EnvBuildContainer.container</span></code></a></li>
 </ul>
 </li>
 </ul>

reference/_autoapi/docbuild/models/config/env/EnvBuildContainer.html

@@ -623,6 +623,18 @@ <h1>docbuild.models.config.env.EnvBuildDaps<a class="headerlink" href="#docbuild
 <dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p>
 </dd></dl>
 
+<dl class="py attribute">
+<dt class="sig sig-object py" id="docbuild.models.config.env.EnvBuildDaps.command">
+<span class="sig-name descname"><span class="pre">command</span></span><span class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></span><a class="headerlink" href="#docbuild.models.config.env.EnvBuildDaps.command" title="Link to this definition">#</a></dt>
+<dd><p>The base command used for DAPS execution.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="docbuild.models.config.env.EnvBuildDaps.meta">
+<span class="sig-name descname"><span class="pre">meta</span></span><span class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></span><a class="headerlink" href="#docbuild.models.config.env.EnvBuildDaps.meta" title="Link to this definition">#</a></dt>
+<dd><p>The command used to extract DAPS metadata.</p>
+</dd></dl>
+
 </dd></dl>
 
 </section>
@@ -676,6 +688,8 @@ <h1>docbuild.models.config.env.EnvBuildDaps<a class="headerlink" href="#docbuild
     <ul class="visible nav section-nav flex-column">
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#docbuild.models.config.env.EnvBuildDaps"><code class="docutils literal notranslate"><span class="pre">docbuild.models.config.env.EnvBuildDaps</span></code></a><ul class="nav section-nav flex-column">
 <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#docbuild.models.config.env.EnvBuildDaps.model_config"><code class="docutils literal notranslate"><span class="pre">docbuild.models.config.env.EnvBuildDaps.model_config</span></code></a></li>
+<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#docbuild.models.config.env.EnvBuildDaps.command"><code class="docutils literal notranslate"><span class="pre">docbuild.models.config.env.EnvBuildDaps.command</span></code></a></li>
+<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#docbuild.models.config.env.EnvBuildDaps.meta"><code class="docutils literal notranslate"><span class="pre">docbuild.models.config.env.EnvBuildDaps.meta</span></code></a></li>
 </ul>
 </li>
 </ul>

reference/_autoapi/docbuild/models/config/env/EnvBuildDaps.html

@@ -632,7 +632,7 @@ <h1>docbuild.models.config.env.EnvTargetPaths<a class="headerlink" href="#docbui
 <dl class="py attribute">
 <dt class="sig sig-object py" id="docbuild.models.config.env.EnvTargetPaths.backup_dir">
 <span class="sig-name descname"><span class="pre">backup_dir</span></span><span class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/pathlib.html#pathlib.Path" title="(in Python v3.14)"><span class="pre">pathlib.Path</span></a></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></span><a class="headerlink" href="#docbuild.models.config.env.EnvTargetPaths.backup_dir" title="Link to this definition">#</a></dt>
-<dd><p>Directory for backups.</p>
+<dd><p>Local directory for storing build backups before deployment.</p>
 </dd></dl>
 
 </dd></dl>