deploy: 3e3bb1c

Author: tomschr

_sources/developer/project-dependencies.rst.txt

@@ -56,5 +56,5 @@ External tools
 * |daps|: Our tool to build documentation. This is an obligatory requirement. This adds other dependencies.
 * |uv|: The Python package and project manager. This is explained in :ref:`devel-helpers`.
 * :command:`make`: Used to orchestrate the documentation build process.
-* `jing <https://jing.nu/>`: For validating the XML configuration files against their RNC schema.
-* `gh <https://cli.github.com/>`: The GitHub CLI, an optional tool for GitHub interactions. See :ref:`github-cli`.
+* `jing <https://jing.nu/>`_: For validating the XML configuration files against their RNC schema.
+* `gh <https://cli.github.com/>`_: The GitHub CLI, an optional tool for GitHub interactions. See :ref:`github-cli`.

_sources/reference/_autoapi/docbuild/constants/index.rst.txt

@@ -35,6 +35,7 @@ Attributes
    docbuild.constants.APP_CONFIG_FILENAME
    docbuild.constants.ENV_CONFIG_FILENAME
    docbuild.constants.DEFAULT_ENV_CONFIG_FILENAME
+   docbuild.constants.GITLOGGER_NAME
    docbuild.constants.BASE_LOG_DIR
    docbuild.constants.XMLDATADIR
 
@@ -172,6 +173,13 @@ Module Contents
    used in production.
 
 
+.. py:data:: GITLOGGER_NAME
+   :value: 'docbuild.git'
+
+
+   The standardized name for the Git-related logger.
+
+
 .. py:data:: BASE_LOG_DIR
 
    The directory where log files will be stored, typically at

_sources/reference/_autoapi/docbuild/logging/index.rst.txt

@@ -9,50 +9,18 @@ docbuild.logging
 
 
 
-Attributes
-----------
-
-.. autoapisummary::
-
-   docbuild.logging.LOGGERNAME
-   docbuild.logging.LOGFILE
-   docbuild.logging.KEEP_LOGS
-
-
 Functions
 ---------
 
 .. autoapisummary::
 
    docbuild.logging.create_base_log_dir
    docbuild.logging.setup_logging
-   docbuild.logging.get_effective_level
 
 
 Module Contents
 ---------------
 
-.. py:data:: LOGGERNAME
-   :value: 'docbuild'
-
-
-   Name of the main logger for the application.
-
-
-.. py:data:: LOGFILE
-   :value: 'docbuild.log'
-
-
-   Filename for the main log file.
-
-
-.. py:data:: KEEP_LOGS
-   :value: 4
-
-
-   Number of log files to keep before rolling over.
-
-
 .. py:function:: create_base_log_dir(base_log_dir: str | pathlib.Path = BASE_LOG_DIR) -> pathlib.Path
 
    Create the base log directory if it doesn't exist.
@@ -65,24 +33,11 @@ Module Contents
    :return: The path to the base log directory.
 
 
-.. py:function:: setup_logging(cliverbosity: int | None, fmt: str = '[%(levelname)s] %(funcName)s: %(message)s', logdir: str | pathlib.Path | None = None, default_logdir: str | pathlib.Path = BASE_LOG_DIR, use_queue: bool = True) -> None
-
-   Set up logging for the application.
-
-   :param cliverbosity: The verbosity level from the command line.
-   :param fmt: The format string for log messages.
-   :param logdir: The directory where log files should be stored.
-   :param default_logdir: The default directory for logs.
-   :param use_queue: Whether to use QueueHandler and QueueListener (for production).
-
-
-.. py:function:: get_effective_level(verbosity: int | None, offset: int = 0) -> int
+.. py:function:: setup_logging(cliverbosity: int, user_config: dict[str, Any] | None = None) -> None
 
-   Return a valid log level, clamped safely.
+   Sets up a non-blocking, configurable logging system.
 
-   :param verbosity: The verbosity level, typically from command
-     line arguments (range 0..8)
-   :param offset: An offset to apply to the verbosity level.
-   :return: The effective log level.
+   :param cliverbosity: ...
+   :param user_config: ...
 
 

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

@@ -1,7 +1,7 @@
 docbuild.models.language.LanguageCode
 =====================================
 
-.. py:class:: docbuild.models.language.LanguageCode(language: str, **kwargs: dict[Any, Any])
+.. py:class:: docbuild.models.language.LanguageCode(/, **data: Any)
 
    Bases: :py:obj:`pydantic.BaseModel`
 

changelog.html

@@ -507,7 +507,7 @@ <h3>Features<a class="headerlink" href="#features" title="Link to this heading">
 <ul class="simple">
 <li><p>Implement metadata from a <code class="docutils literal notranslate"><span class="pre">daps</span> <span class="pre">metadata</span></code> command. (<a class="extlink-gh reference external" href="https://github.com/openSUSE/docbuild/issues/16">GH #16</a>)</p></li>
 <li><p>Add new context manager <a class="reference internal" href="reference/_autoapi/docbuild/utils/contextmgr/PersistentOnErrorTemporaryDirectory.html#docbuild.utils.contextmgr.PersistentOnErrorTemporaryDirectory" title="docbuild.utils.contextmgr.PersistentOnErrorTemporaryDirectory"><code class="xref py py-class docutils literal notranslate"><span class="pre">PersistentOnErrorTemporaryDirectory</span></code></a>.
-It is derived from <a class="reference external" href="https://docs.python.org/3/library/tempfile.html#tempfile.TemporaryDirectory" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">tempfile.TemporaryDirectory</span></code></a> and has a similar behavior, but it does not delete the temporary directory on exit if an exception occurs. (<a class="extlink-gh reference external" href="https://github.com/openSUSE/docbuild/issues/49">GH #49</a>)</p></li>
+It is derived from <a class="reference external" href="https://docs.python.org/3/library/tempfile.html#tempfile.TemporaryDirectory" title="(in Python v3.14)"><code class="xref py py-class docutils literal notranslate"><span class="pre">tempfile.TemporaryDirectory</span></code></a> and has a similar behavior, but it does not delete the temporary directory on exit if an exception occurs. (<a class="extlink-gh reference external" href="https://github.com/openSUSE/docbuild/issues/49">GH #49</a>)</p></li>
 <li><p>Allow optional slash in Doctype syntax.
 Now it’s allowed to write instead of <code class="docutils literal notranslate"><span class="pre">&quot;*/*/*&quot;</span></code> the syntax <code class="docutils literal notranslate"><span class="pre">&quot;/*/*/*&quot;</span></code> and all variations of it. It’s the same, but helps to avoid accidental errors. (<a class="extlink-gh reference external" href="https://github.com/openSUSE/docbuild/issues/50">GH #50</a>)</p></li>
 <li><p>Implement async-aware context manager (<a class="extlink-gh reference external" href="https://github.com/openSUSE/docbuild/issues/52">GH #52</a>)</p></li>
@@ -684,7 +684,7 @@ <h3>Features<a class="headerlink" href="#id14" title="Link to this heading">#</a
 <ul class="simple">
 <li><p><a class="reference internal" href="reference/_autoapi/docbuild/logging/index.html#docbuild.logging.create_base_log_dir" title="docbuild.logging.create_base_log_dir"><code class="xref py py-func docutils literal notranslate"><span class="pre">create_base_log_dir()</span></code></a>: Create the base log directory if it doesn’t exist.</p></li>
 <li><p><a class="reference internal" href="reference/_autoapi/docbuild/logging/index.html#docbuild.logging.setup_logging" title="docbuild.logging.setup_logging"><code class="xref py py-func docutils literal notranslate"><span class="pre">setup_logging()</span></code></a>: Set up logging for the application.</p></li>
-<li><p><a class="reference internal" href="reference/_autoapi/docbuild/logging/index.html#docbuild.logging.get_effective_level" title="docbuild.logging.get_effective_level"><code class="xref py py-func docutils literal notranslate"><span class="pre">get_effective_level()</span></code></a>: Return a valid log level, clamped safely.</p></li>
+<li><p><code class="xref py py-func docutils literal notranslate"><span class="pre">get_effective_level()</span></code>: Return a valid log level, clamped safely.</p></li>
 </ul>
 <p>The <cite>setup_logging</cite> sets different loggers for the app itself, for Jinja,
 XPath, and Git.</p>

developer/design.html

@@ -578,7 +578,7 @@ <h2>Project design structure<a class="headerlink" href="#project-design-structur
 <h2>Commandline design patterns<a class="headerlink" href="#commandline-design-patterns" title="Link to this heading">#</a></h2>
 <p>The commandline interface is designed to be intuitive and user-friendly, following these patterns:</p>
 <ul class="simple">
-<li><p><strong>Dependency</strong>: The CLI is built using the <a class="reference external" href="https://click.palletsprojects.com/en/latest/api/#module-click" title="(in Click v8.2.x)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">click</span></code></a> library, which provides a simple and powerful way to create command-line interfaces in Python.</p></li>
+<li><p><strong>Dependency</strong>: The CLI is built using the <a class="reference external" href="https://click.palletsprojects.com/en/latest/api/#module-click" title="(in Click v8.3.x)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">click</span></code></a> library, which provides a simple and powerful way to create command-line interfaces in Python.</p></li>
 <li><p><strong>Subcommands</strong>: The CLI uses subcommands to organize functionality.</p></li>
 <li><p><strong>Options and Arguments</strong>: Options are used to modify the behavior of commands, while arguments are used to specify input data.</p></li>
 <li><p><strong>Help and Documentation</strong>: Each command and option has a help message that can be accessed using the <code class="docutils literal notranslate"><span class="pre">--help</span></code> flag. This provides users with information on how to use the command and its options.</p></li>

developer/project-dependencies.html

@@ -517,8 +517,8 @@ <h2>External tools<a class="headerlink" href="#external-tools" title="Link to th
 <li><p><strong class="command">daps</strong>: Our tool to build documentation. This is an obligatory requirement. This adds other dependencies.</p></li>
 <li><p><strong class="command">uv</strong>: The Python package and project manager. This is explained in <a class="reference internal" href="prepare-environment.html#devel-helpers"><span class="std std-ref">Helper Tools</span></a>.</p></li>
 <li><p><strong class="command">make</strong>: Used to orchestrate the documentation build process.</p></li>
-<li><p><cite>jing &lt;https://jing.nu/&gt;</cite>: For validating the XML configuration files against their RNC schema.</p></li>
-<li><p><cite>gh &lt;https://cli.github.com/&gt;</cite>: The GitHub CLI, an optional tool for GitHub interactions. See <a class="reference internal" href="prepare-environment.html#github-cli"><span class="std std-ref">GitHub CLI</span></a>.</p></li>
+<li><p><a class="reference external" href="https://jing.nu/">jing</a>: For validating the XML configuration files against their RNC schema.</p></li>
+<li><p><a class="reference external" href="https://cli.github.com/">gh</a>: The GitHub CLI, an optional tool for GitHub interactions. See <a class="reference internal" href="prepare-environment.html#github-cli"><span class="std std-ref">GitHub CLI</span></a>.</p></li>
 </ul>
 </section>
 </section>

genindex.html

@@ -421,7 +421,6 @@ <h1 id="index">Index</h1>
  | <a href="#G"><strong>G</strong></a>
  | <a href="#H"><strong>H</strong></a>
  | <a href="#I"><strong>I</strong></a>
- | <a href="#K"><strong>K</strong></a>
  | <a href="#L"><strong>L</strong></a>
  | <a href="#M"><strong>M</strong></a>
  | <a href="#N"><strong>N</strong></a>
@@ -1257,16 +1256,16 @@ <h2 id="G">G</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="reference/_autoapi/docbuild/cli/cmd_metadata/metaprocess/index.html#docbuild.cli.cmd_metadata.metaprocess.get_deliverable_from_doctype">get_deliverable_from_doctype() (in module docbuild.cli.cmd_metadata.metaprocess)</a>
-</li>
-      <li><a href="reference/_autoapi/docbuild/logging/index.html#docbuild.logging.get_effective_level">get_effective_level() (in module docbuild.logging)</a>
 </li>
       <li><a href="glossary.html#term-GIL"><strong>GIL</strong></a>
 </li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="reference/_autoapi/docbuild/models/deliverable/Deliverable.html#docbuild.models.deliverable.Deliverable.git">git (docbuild.models.deliverable.Deliverable property)</a>
 </li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="glossary.html#term-GitHub-Action"><strong>GitHub Action</strong></a>
+</li>
+      <li><a href="reference/_autoapi/docbuild/constants/index.html#docbuild.constants.GITLOGGER_NAME">GITLOGGER_NAME (in module docbuild.constants)</a>
 </li>
       <li><a href="glossary.html#term-Global-Interpreter-Lock"><strong>Global Interpreter Lock</strong></a>
 </li>
@@ -1293,14 +1292,6 @@ <h2 id="I">I</h2>
   </ul></td>
 </tr></table>
 
-<h2 id="K">K</h2>
-<table style="width: 100%" class="indextable genindextable"><tr>
-  <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="reference/_autoapi/docbuild/logging/index.html#docbuild.logging.KEEP_LOGS">KEEP_LOGS (in module docbuild.logging)</a>
-</li>
-  </ul></td>
-</tr></table>
-
 <h2 id="L">L</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
@@ -1320,14 +1311,14 @@ <h2 id="L">L</h2>
       </ul></li>
       <li><a href="glossary.html#term-Lifecycle"><strong>Lifecycle</strong></a>
 </li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="reference/_autoapi/docbuild/models/deliverable/Deliverable.html#docbuild.models.deliverable.Deliverable.lifecycle">lifecycle (docbuild.models.deliverable.Deliverable property)</a>
 
       <ul>
         <li><a href="reference/_autoapi/docbuild/models/doctype/Doctype.html#docbuild.models.doctype.Doctype.lifecycle">(docbuild.models.doctype.Doctype attribute)</a>
 </li>
       </ul></li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="reference/_autoapi/docbuild/models/lifecycle/index.html#docbuild.models.lifecycle.LifecycleFlag">LifecycleFlag (in module docbuild.models.lifecycle)</a>
 </li>
       <li><a href="reference/_autoapi/docbuild/constants/index.html#docbuild.constants.LIFECYCLES_STR">LIFECYCLES_STR (in module docbuild.constants)</a>
@@ -1339,10 +1330,6 @@ <h2 id="L">L</h2>
       <li><a href="reference/_autoapi/docbuild/config/xml/stitch/index.html#docbuild.config.xml.stitch.load_check_functions">load_check_functions() (in module docbuild.config.xml.stitch)</a>
 </li>
       <li><a href="reference/_autoapi/docbuild/config/load/index.html#docbuild.config.load.load_single_config">load_single_config() (in module docbuild.config.load)</a>
-</li>
-      <li><a href="reference/_autoapi/docbuild/logging/index.html#docbuild.logging.LOGFILE">LOGFILE (in module docbuild.logging)</a>
-</li>
-      <li><a href="reference/_autoapi/docbuild/logging/index.html#docbuild.logging.LOGGERNAME">LOGGERNAME (in module docbuild.logging)</a>
 </li>
   </ul></td>
 </tr></table>

objects.inv

@@ -613,7 +613,7 @@ <h2>Functions<a class="headerlink" href="#functions" title="Link to this heading
 <h2>Package Contents<a class="headerlink" href="#package-contents" title="Link to this heading">#</a></h2>
 <dl class="py function">
 <dt class="sig sig-object py" id="docbuild.cli.cmd_build.build">
-<span class="sig-prename descclassname"><span class="pre">docbuild.cli.cmd_build.</span></span><span class="sig-name descname"><span class="pre">build</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ctx</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://click.palletsprojects.com/en/latest/api/#click.Context" title="(in Click v8.2.x)"><span class="pre">click.Context</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">doctypes</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.13)"><span class="pre">tuple</span></a><span class="p"><span class="pre">[</span></span><a class="reference internal" href="../../models/doctype/Doctype.html#docbuild.models.doctype.Doctype" title="docbuild.models.doctype.Doctype"><span class="pre">docbuild.models.doctype.Doctype</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#docbuild.cli.cmd_build.build" title="Link to this definition">#</a></dt>
+<span class="sig-prename descclassname"><span class="pre">docbuild.cli.cmd_build.</span></span><span class="sig-name descname"><span class="pre">build</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ctx</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://click.palletsprojects.com/en/latest/api/#click.Context" title="(in Click v8.3.x)"><span class="pre">click.Context</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">doctypes</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.14)"><span class="pre">tuple</span></a><span class="p"><span class="pre">[</span></span><a class="reference internal" href="../../models/doctype/Doctype.html#docbuild.models.doctype.Doctype" title="docbuild.models.doctype.Doctype"><span class="pre">docbuild.models.doctype.Doctype</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#docbuild.cli.cmd_build.build" title="Link to this definition">#</a></dt>
 <dd><p>Subcommand build.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>