python-netgear-switch-library 0.0.post322__tar.gz → 0.0.post323__tar.gz

{python_netgear_switch_library-0.0.post322 → python_netgear_switch_library-0.0.post323}/.github/workflows/ci.yml

@@ -65,8 +65,15 @@ jobs:
       - name: Sync the docs extra
         run: uv sync --extra docs
 
-      - name: Build the documentation (warnings are errors)
-        run: uv run sphinx-build -W --keep-going -b html docs docs/_build/html
+      # Read the Docs' EXACT invocation, `-j auto` included. That flag matters:
+      # a parallel read needs every registered Sphinx domain to implement
+      # merge_domaindata, and sphinx-argparse's does not -- which broke the
+      # published build while a gate without `-j auto` stayed green. Run what
+      # production runs.
+      - name: Build the documentation (Read the Docs' command, warnings are errors)
+        run: >
+          uv run python -m sphinx -T -W --keep-going -j auto -b html
+          -d docs/_build/doctrees -D language=en docs docs/_build/html
 
       - name: Upload the built documentation
         uses: actions/upload-artifact@v4

{python_netgear_switch_library-0.0.post322 → python_netgear_switch_library-0.0.post323}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-netgear-switch-library
-Version: 0.0.post322
+Version: 0.0.post323
 Summary: Python library and CLI to query and control Netgear switches over SNMP, NSDP and HTTP.
 Author-email: Tim Ansell <me@mith.ro>
 License-Expression: Apache-2.0

{python_netgear_switch_library-0.0.post322 → python_netgear_switch_library-0.0.post323}/docs/conf.py

@@ -18,6 +18,10 @@ from datetime import UTC, datetime
 from importlib.metadata import PackageNotFoundError
 from importlib.metadata import version as pkg_version
 from pathlib import Path
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from sphinx.application import Sphinx
 
 DOCS_DIR = Path(__file__).parent
 REPO_ROOT = DOCS_DIR.parent
@@ -135,3 +139,34 @@ html_theme_options = {
 
 copybutton_prompt_text = r"\$ |>>> |\.\.\. "
 copybutton_prompt_is_regexp = True
+
+
+# -- Build tweaks -------------------------------------------------------------
+
+
+def _force_serial_build(app: Sphinx) -> None:
+    """Read and write documents serially, whatever ``-j`` was passed.
+
+    Read the Docs always invokes Sphinx with ``-j auto``, and a parallel READ
+    requires every registered domain to implement ``merge_domaindata`` so the
+    workers' results can be combined. ``sphinx-argparse`` registers an
+    ``ArgParseDomain`` that does not, so a parallel build dies with::
+
+        NotImplementedError: merge_domaindata must be implemented in
+        <class 'sphinxarg.ext.ArgParseDomain'> to be able to do parallel builds!
+
+    Forcing ``parallel`` back to 1 here is a deliberate trade of build time for
+    a working build; it is the only knob available, since Read the Docs does not
+    expose the ``-j`` flag in ``.readthedocs.yaml``. Serial is ~5 minutes for
+    this project, well inside any build timeout. Remove this once
+    sphinx-argparse implements ``merge_domaindata``.
+
+    This is why the CI documentation job passes ``-j auto`` too (see
+    ``.github/workflows/ci.yml``): the gate must run the command Read the Docs
+    runs, or a failure like this one reaches production with CI still green.
+    """
+    app.parallel = 1
+
+
+def setup(app: Sphinx) -> None:
+    app.connect("builder-inited", _force_serial_build)

{python_netgear_switch_library-0.0.post322 → python_netgear_switch_library-0.0.post323}/src/netgear_switch/_version.py

@@ -18,7 +18,7 @@ version_tuple: tuple[int | str, ...]
 commit_id: str | None
 __commit_id__: str | None
 
-__version__ = version = '0.0.post322'
-__version_tuple__ = version_tuple = (0, 0, 'post322')
+__version__ = version = '0.0.post323'
+__version_tuple__ = version_tuple = (0, 0, 'post323')
 
 __commit_id__ = commit_id = None