Merge remote-tracking branch 'origin/main' into add-domain-rebase-2025

Author: Robert Roos

.github/workflows/ci.yml

@@ -34,25 +34,27 @@ jobs:
         - "3.10"
         - "3.11"
         - "3.12"
+        - "3.13"
+        - "3.14"
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: ${{ matrix.python-version }}
       - name: Check Python version
         run: python --version --version
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          python -m pip install .[test] pytest-cov
+          python -m pip install .[test]
       - name: Test with pytest
         run: >
           python -m pytest
           -vv
           --cov . --cov-append --cov-config pyproject.toml
       - name: Upload coverage to Codecov
-        uses: codecov/codecov-action@v4
+        uses: codecov/codecov-action@v5
         with:
           flags: unittests

.github/workflows/lint.yml

@@ -16,57 +16,47 @@ env:
   FORCE_COLOR: "1"
 
 jobs:
-  ruff:
+  lint:
+    name: "Ruff & MyPy"
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v6
     - name: Set up Python
-      uses: actions/setup-python@v5
+      uses: actions/setup-python@v6
       with:
-        python-version: "3"
-    - name: Install pip
-      run: python -m pip install --upgrade pip
-
-    - name: Install Ruff
-      run: python -m pip install "ruff==0.5.2"
+        python-version: "3.13"
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install .[lint] pytest
+      # Also install pytest here, otherwise mypy will complain about our test files
 
     - name: Lint with Ruff
       run: ruff check . --output-format github
 
     - name: Format with Ruff
       run: ruff format . --diff
 
-  mypy:
-    runs-on: ubuntu-latest
-
-    steps:
-    - uses: actions/checkout@v4
-    - name: Set up Python
-      uses: actions/setup-python@v5
-      with:
-        python-version: "3"
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        python -m pip install ".[lint,test]"
-    - name: Type check with mypy
-      run: mypy
+#    - name: Type check with MyPy
+#      run: mypy
+# Skip MyPy check for now, see https://github.com/sphinx-doc/sphinx-argparse/issues/85
 
   twine:
+    name: "Check packing with Twine"
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v6
     - name: Set up Python
-      uses: actions/setup-python@v5
+      uses: actions/setup-python@v6
       with:
-        python-version: "3"
+        python-version: "3.13"
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
         python -m pip install --upgrade twine build
-    - name: Lint with twine
+    - name: Check with twine
       run: |
         python -m build .
         twine check dist/*

.readthedocs.yaml

@@ -1,5 +1,8 @@
 version: 2
 
+sphinx:
+  configuration: docs/conf.py
+
 build:
   os: ubuntu-22.04
   tools:

pyproject.toml

@@ -53,7 +53,7 @@ lint = [
 ]
 test = [
     "pytest>=8.0",
-    "coverage>=6.5",
+    "pytest-cov",
     "lxml>=4.9",
     "setuptools>=70.0",  # for Cython compilation
     "typing_extensions>=4.9",  # for typing_extensions.Unpack

sphinxarg/ext.py

@@ -764,15 +764,11 @@ def run(self):
         if 'prog' in self.options:
             parser.prog = self.options['prog']
 
-        # Argparse in Python 3.14 uses ANSI color codes by default (#72)
-        if hasattr(parser, 'color'):
-            parser.color = 'color' in self.options
-            # Disable colors, unless a flag is present in the user-settings
-
         result = parse_parser(
             parser,
             skip_default_values='nodefault' in self.options,
             skip_default_const_values='nodefaultconst' in self.options,
+            color='color' in self.options,
         )
         result = parser_navigate(result, path)
         if 'manpage' in self.options:

sphinxarg/parser.py

@@ -55,6 +55,18 @@ def _format_usage_without_prefix(parser):
 
 
 def parse_parser(parser, data=None, **kwargs):
+    """Take data from argparse argument parser.
+
+    Keyword arguments:
+        - skip_default_values
+        - skip_default_const_values
+        - color
+    """
+    # Argparse in Python 3.14 uses ANSI color codes by default (#72)
+    if hasattr(parser, 'color'):
+        parser.color = kwargs.get('color', False)
+        # Disable colors, unless a flag is presented through user-settings
+
     if data is None:
         data = {
             'name': '',
@@ -85,6 +97,11 @@ def parse_parser(parser, data=None, **kwargs):
         for name, subaction in action._name_parser_map.items():
             if name in subsection_alias_names:
                 continue
+
+            if hasattr(subaction, 'color'):
+                subaction.color = parser.color
+                # Color is not inherited, must be set again
+
             subalias = subsection_alias[subaction]
             subaction.prog = f'{parser.prog} {name}'
             subdata = {