deploy: 4daccc9

Author: sushant-suse

_sources/reference/_autoapi/docbuild/cli/cmd_validate/index.rst.txt

@@ -29,10 +29,12 @@ Functions
 Package Contents
 ----------------
 
-.. py:function:: validate(ctx: click.Context, xmlfiles: tuple | collections.abc.Iterator[pathlib.Path]) -> None
+.. py:function:: validate(ctx: click.Context, xmlfiles: tuple | collections.abc.Iterator[pathlib.Path], validation_method: str) -> None
 
    Subcommand to validate XML configuration files.
 
    :param ctx: The Click context object.
+   :param xmlfiles: XML files to validate, if empty all XMLs in config dir are used.
+   :param validation_method: Validation method to use, 'jing' or 'lxml'.
 
 

_sources/reference/_autoapi/docbuild/cli/cmd_validate/process/index.rst.txt

@@ -17,6 +17,7 @@ Functions
    docbuild.cli.cmd_validate.process.display_results
    docbuild.cli.cmd_validate.process.run_command
    docbuild.cli.cmd_validate.process.validate_rng
+   docbuild.cli.cmd_validate.process.validate_rng_lxml
    docbuild.cli.cmd_validate.process.run_python_checks
    docbuild.cli.cmd_validate.process.process_file
    docbuild.cli.cmd_validate.process.process
@@ -47,7 +48,7 @@ Module Contents
    :raises FileNotFoundError: if the command is not found.
 
 
-.. py:function:: validate_rng(xmlfile: pathlib.Path, rng_schema_path: pathlib.Path = PRODUCT_CONFIG_SCHEMA, *, xinclude: bool = True) -> tuple[bool, str]
+.. py:function:: validate_rng(xmlfile: pathlib.Path, rng_schema_path: pathlib.Path = PRODUCT_CONFIG_SCHEMA, *, xinclude: bool = True, idcheck: bool = True) -> tuple[bool, str]
    :async:
 
 
@@ -58,12 +59,24 @@ Module Contents
    more robust for complex XInclude statements, including those with XPointer.
 
    :param xmlfile: The path to the XML file to validate.
-   :param rng_schema_path: The path to the RELAX NG schema file. It supports
-       both RNC and RNG formats.
+   :param rng_schema_path: The path to the RELAX NG schema file. It supports both RNC and RNG formats.
    :param xinclude: If True, resolve XIncludes with `xmllint` before validation.
+   :param idcheck: If True, perform ID uniqueness checks.
    :return: A tuple containing a boolean success status and any output message.
 
 
+.. py:function:: validate_rng_lxml(xmlfile: pathlib.Path, rng_schema_path: pathlib.Path = PRODUCT_CONFIG_SCHEMA) -> tuple[bool, str]
+
+   Validate an XML file against a RELAX NG (.rng) schema using lxml.
+
+   This function uses lxml.etree.RelaxNG, which supports only the XML syntax
+   of RELAX NG schemas (i.e., .rng files, not .rnc files).
+
+   :param xmlfile: Path to the XML file to validate.
+   :param rng_schema_path: Path to the RELAX NG (.rng) schema file.
+   :return: Tuple of (is_valid: bool, error_message: str)
+
+
 .. py:function:: run_python_checks(tree: lxml.etree._ElementTree) -> list[tuple[str, docbuild.config.xml.checks.CheckResult]]
    :async:
 

_sources/reference/_autoapi/docbuild/cli/context/DocBuildContext.rst.txt

@@ -95,3 +95,12 @@ docbuild.cli.context.DocBuildContext
       If set, enable debug mode
 
 
+
+   .. py:attribute:: validation_method
+      :type:  str
+      :value: 'jing'
+
+
+      Method used to validate XML files: 'jing' (default) or 'lxml'
+
+

_sources/user/build.rst.txt

@@ -37,10 +37,13 @@ The fields in the doctype have the following meanings:
 
 Some common examples of doctypes are:
 
-* ``//en-us``: Matches all supported deliverables in English.
-* ``sles/*/en-us``: Matches all SLES deliverables in English, regardless of the docset or lifecycle.
+* ``sles/15-SP6/en-us``: Matches the English deliverables for SLES 15-SP6, regardless of the lifecycle.
+* ``*/*/de-de``: Matches all deliverables in German, regardless of the product, docset, or lifecycle.
+* ``//en-us``: Matches all deliverables in English, regardless of product, docset, or lifecycle. This is a shorter version of ``*/*/en-us``.
+* ``sles//en-us``: Matches all English SLES deliverables, regardless of the docset or lifecycle.
 * ``sle-ha//@unsupported/en-us,de-de``: Matches all SLE-HA deliverables in English and German that are in the unsupported lifecycle, regardless of the docset.
-* ``"*/@beta,supported/de-de"``: Matches all SLES deliverables in German that are in the beta or supported lifecycle, regardless of the product.
+* ``*/@beta,supported/de-de``: Matches all SLES deliverables in German that are in the beta or supported lifecycle, regardless of the product.
+* ``//``: Matches all deliverables in all languages, regardless of the product, docset, or lifecycle. This is the simplest doctype and matches everything.
 
 
 Minimal set of doctypes
@@ -54,4 +57,4 @@ The command tries to find overlaps in the specified doctypes and only builds the
 
    [1] sles/*/en-us + sles/15-SP6/en-us      => sles/*/en-us
    [2] sles/*/en-us + sles/15-SP6/de-de      => sles/*/en-us,sles/15-SP6/de-de
-   [3] sles/15-SP6/en-us + sles/15-SP6/de-de => sles/15-SP6/en-us,de-de
+   [3] sles/15-SP6/en-us + sles/15-SP6/de-de => sles/15-SP6/en-us,de-de

genindex.html

@@ -467,13 +467,20 @@ <h2 id="Symbols">Symbols</h2>
         <li><a href="reference/docbuild-cli.html#cmdoption-docbuild-env-config">docbuild command line option</a>
 </li>
       </ul></li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li>
     --no-debug
 
       <ul>
         <li><a href="reference/docbuild-cli.html#cmdoption-docbuild-debug">docbuild command line option</a>
+</li>
+      </ul></li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li>
+    --validation-method
+
+      <ul>
+        <li><a href="reference/docbuild-cli.html#cmdoption-docbuild-validate-validation-method">docbuild-validate command line option</a>
 </li>
       </ul></li>
       <li>
@@ -808,6 +815,8 @@ <h2 id="D">D</h2>
     docbuild-validate command line option
 
       <ul>
+        <li><a href="reference/docbuild-cli.html#cmdoption-docbuild-validate-validation-method">--validation-method</a>
+</li>
         <li><a href="reference/docbuild-cli.html#cmdoption-docbuild-validate-arg-XMLFILES">XMLFILES</a>
 </li>
       </ul></li>
@@ -1683,9 +1692,13 @@ <h2 id="V">V</h2>
       <li><a href="reference/_autoapi/docbuild/models/language/LanguageCode.html#docbuild.models.language.LanguageCode.validate_language">validate_language() (docbuild.models.language.LanguageCode class method)</a>
 </li>
       <li><a href="reference/_autoapi/docbuild/cli/cmd_validate/process/index.html#docbuild.cli.cmd_validate.process.validate_rng">validate_rng() (in module docbuild.cli.cmd_validate.process)</a>
+</li>
+      <li><a href="reference/_autoapi/docbuild/cli/cmd_validate/process/index.html#docbuild.cli.cmd_validate.process.validate_rng_lxml">validate_rng_lxml() (in module docbuild.cli.cmd_validate.process)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="reference/_autoapi/docbuild/cli/context/DocBuildContext.html#docbuild.cli.context.DocBuildContext.validation_method">validation_method (docbuild.cli.context.DocBuildContext attribute)</a>
+</li>
       <li><a href="glossary.html#term-VENV"><strong>VENV</strong></a>
 </li>
       <li><a href="reference/_autoapi/docbuild/cli/context/DocBuildContext.html#docbuild.cli.context.DocBuildContext.verbose">verbose (docbuild.cli.context.DocBuildContext attribute)</a>

objects.inv

@@ -590,11 +590,15 @@ <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_validate.validate">
-<span class="sig-prename descclassname"><span class="pre">docbuild.cli.cmd_validate.</span></span><span class="sig-name descname"><span class="pre">validate</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">xmlfiles</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="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Iterator" title="(in Python v3.13)"><span class="pre">collections.abc.Iterator</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/pathlib.html#pathlib.Path" title="(in Python v3.13)"><span class="pre">pathlib.Path</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_validate.validate" title="Link to this definition">#</a></dt>
+<span class="sig-prename descclassname"><span class="pre">docbuild.cli.cmd_validate.</span></span><span class="sig-name descname"><span class="pre">validate</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">xmlfiles</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="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Iterator" title="(in Python v3.13)"><span class="pre">collections.abc.Iterator</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/pathlib.html#pathlib.Path" title="(in Python v3.13)"><span class="pre">pathlib.Path</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">validation_method</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#str" title="(in Python v3.13)"><span class="pre">str</span></a></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_validate.validate" title="Link to this definition">#</a></dt>
 <dd><p>Subcommand to validate XML configuration files.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
-<dd class="field-odd"><p><strong>ctx</strong> – The Click context object.</p>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>ctx</strong> – The Click context object.</p></li>
+<li><p><strong>xmlfiles</strong> – XML files to validate, if empty all XMLs in config dir are used.</p></li>
+<li><p><strong>validation_method</strong> – Validation method to use, ‘jing’ or ‘lxml’.</p></li>
+</ul>
 </dd>
 </dl>
 </dd></dl>