Use hatchling and not compatible with sphinx 6.1

Signed-off-by: Bernát Gábor <[email protected]>

Author: gaborbernat

.markdownlint.yaml

@@ -0,0 +1,8 @@
+MD013:
+  code_blocks: false
+  headers: false
+  line_length: 120
+  tables: false
+
+MD046:
+  style: fenced

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.3.0
+    rev: v4.4.0
     hooks:
       - id: check-ast
       - id: check-builtin-literals
@@ -11,25 +11,30 @@ repos:
       - id: debug-statements
       - id: end-of-file-fixer
       - id: trailing-whitespace
+  - repo: https://github.com/asottile/add-trailing-comma
+    rev: v2.4.0
+    hooks:
+      - id: add-trailing-comma
+        args: [--py36-plus]
   - repo: https://github.com/asottile/pyupgrade
-    rev: v3.2.2
+    rev: v3.3.1
     hooks:
       - id: pyupgrade
-        args: [ "--py37-plus" ]
+        args: ["--py37-plus"]
   - repo: https://github.com/PyCQA/isort
-    rev: 5.10.1
+    rev: 5.11.4
     hooks:
       - id: isort
   - repo: https://github.com/psf/black
-    rev: 22.10.0
+    rev: 22.12.0
     hooks:
       - id: black
-        args: [ --safe ]
+        args: [--safe]
   - repo: https://github.com/asottile/blacken-docs
     rev: v1.12.1
     hooks:
       - id: blacken-docs
-        additional_dependencies: [ black==22.10 ]
+        additional_dependencies: [black==22.12]
   - repo: https://github.com/pre-commit/pygrep-hooks
     rev: v1.9.0
     hooks:
@@ -38,20 +43,33 @@ repos:
     rev: "0.5.2"
     hooks:
       - id: tox-ini-fmt
-        args: [ "-p", "fix" ]
-  - repo: https://github.com/asottile/setup-cfg-fmt
-    rev: v2.2.0
-    hooks:
-      - id: setup-cfg-fmt
+        args: ["-p", "fix"]
   - repo: https://github.com/PyCQA/flake8
-    rev: 5.0.4
+    rev: 6.0.0
     hooks:
       - id: flake8
         additional_dependencies:
-          - flake8-bugbear==22.10.27
+          - flake8-bugbear==22.12.6
           - flake8-comprehensions==3.10.1
           - flake8-pytest-style==1.6
           - flake8-spellcheck==0.28
           - flake8-unused-arguments==0.0.12
-          - flake8-noqa==1.2.9
-          - pep8-naming==0.13.2
+          - flake8-noqa==1.3
+          - pep8-naming==0.13.3
+          - flake8-pyproject==1.2.2
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: "v2.7.1"
+    hooks:
+      - id: prettier
+        additional_dependencies:
+          - [email protected]
+          - "@prettier/[email protected]"
+        args: ["--print-width=120", "--prose-wrap=always"]
+  - repo: https://github.com/igorshubovych/markdownlint-cli
+    rev: v0.32.2
+    hooks:
+      - id: markdownlint
+  - repo: meta
+    hooks:
+      - id: check-hooks-apply
+      - id: check-useless-excludes

CHANGELOG.md

@@ -2,15 +2,19 @@
 
 All notable changes to this project will be documented in this file.
 
+## 1.11.0
+
+- Hatchling as backend and exclude sphinx 6.1 support.
+
 ## 1.10.0
 
 - Add the option to override the generated `default` part of the CLI parameter description.
 
 ## 1.9.0
 
 - Add the option to override the description using the `description` attribute of the directive
-- Add the option to retrieve the arguments by hooking argparse, in cases where `func` consumes the arguments
-  and does not return them
+- Add the option to retrieve the arguments by hooking argparse, in cases where `func` consumes the arguments and does
+  not return them
 
 ## 1.8.2
 
@@ -27,7 +31,8 @@ All notable changes to this project will be documented in this file.
 
 ## 1.7.0
 
-- Support for adding custom subsection group title prefix (`group_title_prefix` and `group_sub_title_prefix` directive arguments)
+- Support for adding custom subsection group title prefix (`group_title_prefix` and `group_sub_title_prefix` directive
+  arguments)
 
 ## 1.6.0 (2021-04-15)
 

pyproject.toml

@@ -1,24 +1,75 @@
 [build-system]
-requires = ["setuptools>=65.5", "setuptools-scm>=7.0.5"]
-build-backend = "setuptools.build_meta"
+build-backend = "hatchling.build"
+requires = ["hatchling>=1.12", "hatch-vcs>=0.3"]
+
+[project]
+name = "sphinx_argparse_cli"
+description = "render CLI arguments (sub-commands friendly) defined by argparse module"
+readme = "README.md"
+license = "MIT"
+maintainers = [{ name = "Bernat Gabor", email = "[email protected]" }]
+urls.Documentation = "https://github.com/tox-dev/sphinx-argparse-cli#sphinx-argparse-cli"
+urls.Homepage = "https://github.com/tox-dev/sphinx-argparse-cli"
+urls.Source = "https://github.com/tox-dev/sphinx-argparse-cli"
+urls.Tracker = "https://github.com/tox-dev/sphinx-argparse-cli/issues"
+classifiers = [
+  "Development Status :: 5 - Production/Stable",
+  "Environment :: Console",
+  "Framework :: Sphinx",
+  "Framework :: Sphinx :: Extension",
+  "Intended Audience :: Developers",
+  "License :: OSI Approved :: MIT License",
+  "Operating System :: OS Independent",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3 :: Only",
+  "Programming Language :: Python :: Implementation :: CPython",
+  "Topic :: Documentation",
+  "Topic :: Documentation :: Sphinx",
+]
+keywords = ["sphinx", "argparse"]
+requires-python = ">=3.7"
+dependencies = ["sphinx>=5.3,!=6.1"]
+optional-dependencies.test = ["covdefaults>=2.2.2", "pytest>=7.2", "pytest-cov>=4"]
+dynamic = ["version"]
+
+[tool.hatch]
+build.hooks.vcs.version-file = "src/sphinx_argparse_cli/version.py"
+build.targets.sdist.include = ["/src", "/tests"]
+version.source = "vcs"
 
 [tool.black]
 line-length = 120
 
+[tool.coverage]
+html.show_contexts = true
+html.skip_covered = false
+paths.source = ["src", "**/site-packages"]
+report.fail_under = 76
+run.dynamic_context = "test_function"
+run.parallel = true
+run.plugins = ["covdefaults"]
+run.relative_files = true
+
 [tool.isort]
+known_first_party = ["sphinx_argparse_cli", "tests"]
 profile = "black"
-known_first_party = ["sphinx_argparse_cli"]
+line_length = 120
 
-[tool.setuptools_scm]
-write_to = "src/sphinx_argparse_cli/version.py"
-write_to_template = """
-\"\"\" Version information \"\"\"
-from __future__ import annotations
+[tool.mypy]
+python_version = "3.11"
+show_error_codes = true
+strict = true
 
-__version__: str = "{version}"
-"""
+[tool.pep8]
+max-line-length = "120"
 
-[tool.pytest.ini_options]
-filterwarnings = [
-    "ignore::DeprecationWarning:docutils",
+[tool.flake8]
+max-complexity = 22
+max-line-length = 120
+unused-arguments-ignore-abstract-functions = true
+noqa-require-code = true
+dictionaries = ["en_US", "python", "technical", "django"]
+ignore = [
+  "E203", # whitespace before ':'
+  "W503", #  line break before binary operator
 ]

setup.cfg

@@ -32,12 +32,7 @@
     title,
     whitespace_normalize_name,
 )
-from docutils.parsers.rst.directives import (
-    flag,
-    positive_int,
-    unchanged,
-    unchanged_required,
-)
+from docutils.parsers.rst.directives import flag, positive_int, unchanged, unchanged_required
 from docutils.parsers.rst.states import RSTState, RSTStateMachine
 from docutils.statemachine import StringList
 from sphinx.domains.std import StandardDomain

setup.py

@@ -23,7 +23,7 @@ commands =
     pytest {tty:--color=yes} {posargs: \
       --junitxml {toxworkdir}{/}junit.{envname}.xml --cov {envsitepackagesdir}{/}sphinx_argparse_cli \
       --cov {toxinidir}{/}tests --cov-fail-under=100 \
-      --cov-config=setup.cfg --no-cov-on-fail --cov-report term-missing:skip-covered --cov-context=test \
+      --cov-config=pyproject.toml --no-cov-on-fail --cov-report term-missing:skip-covered --cov-context=test \
       --cov-report html:{envtmpdir}{/}htmlcov --cov-report xml:{toxworkdir}{/}coverage.{envname}.xml \
       tests}
 package = wheel
@@ -37,7 +37,7 @@ passenv =
 basepython = python3.10
 skip_install = true
 deps =
-    pre-commit>=2.20
+    pre-commit>=2.21
 commands =
     pre-commit run --all-files --show-diff-on-failure
     python -c 'print("hint: run {envdir}/bin/pre-commit install to add checks as pre-commit hook")'
@@ -47,19 +47,19 @@ description = run type check on code base
 setenv =
     {tty:MYPY_FORCE_COLOR = 1}
 deps =
-    mypy==0.982
+    mypy==0.991
     types-docutils>=0.19.1.1
 commands =
-    mypy --strict --python-version 3.10 src
-    mypy --strict --python-version 3.10 tests
+    mypy src
+    mypy tests
 
 [testenv:pkg_check]
 description = check that the long description is valid
 basepython = python3.10
 skip_install = true
 deps =
     build[virtualenv]>=0.9
-    twine>=4.0.1
+    twine>=4.0.2
 changedir = {toxinidir}
 commands =
     python -m build --sdist --wheel -o {envtmpdir} .
@@ -75,15 +75,3 @@ extras =
 commands =
     python -m pip list --format=columns
     python -c 'import sys; print(sys.executable)'
-
-[pytest]
-junit_family = xunit2
-
-[flake8]
-max-complexity = 22
-max-line-length = 120
-noqa-require-code = true
-dictionaries = en_US,python,technical,django
-ignore =
-    E203 # whitespace before :
-    W503 # line break before binary operator