Merge branch 'main' into remove-markdownlint

ComPWA · Sep 28, 2023 · 63e7eb7 · 63e7eb7
2 parents c157f00 + 8d9dac3
commit 63e7eb7
Show file tree

Hide file tree

Showing 22 changed files with 55 additions and 53 deletions.
diff --git a/.cspell.json b/.cspell.json
@@ -72,7 +72,6 @@
     "rtfd",
     "sdist",
     "setuptools",
-    "sphinxcontrib",
     "testroot",
     "unittests",
     "venv"

diff --git a/.github/release-drafter.yml b/.github/release-drafter.yml
@@ -1,4 +1,4 @@
-name-template: sphinxcontrib.hep.pdgref $NEXT_PATCH_VERSION
+name-template: sphinx-hep-pdgref $NEXT_PATCH_VERSION
 tag-template: $NEXT_PATCH_VERSION
 
 references:
@@ -34,4 +34,4 @@ sort-direction: ascending
 template: |
   $CHANGES
 
-  _The full changelog as commits can be found [here](https://github.com/ComPWA/sphinxcontrib-hep-pdgref/compare/$PREVIOUS_TAG...$NEXT_PATCH_VERSION)._
+  _The full changelog as commits can be found [here](https://github.com/ComPWA/sphinx-hep-pdgref/compare/$PREVIOUS_TAG...$NEXT_PATCH_VERSION)._
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -29,7 +29,7 @@ jobs:
   pytest:
     uses: ComPWA/actions/.github/workflows/pytest.yml@v1
     with:
-      coverage-target: sphinxcontrib
+      coverage-target: sphinx_hep_pdgref
       macos-python-version: "3.9"
       specific-pip-packages: ${{ inputs.specific-pip-packages }}
   style:

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -46,8 +46,8 @@ repos:
       - id: check-dev-files
         args:
           - --no-notebooks
-          - --repo-name=sphinxcontrib-hep-pdgref
-          - --repo-title=sphinxcontrib.hep.pdgref
+          - --repo-name=sphinx-hep-pdgref
+          - --repo-title=sphinx-hep-pdgref
       - id: format-setup-cfg
 
   - repo: https://github.com/psf/black

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,7 +1,7 @@
 # How to contribute?
 
-[![Open in Visual Studio Code](https://img.shields.io/badge/vscode-open-blue?logo=visualstudiocode)](https://open.vscode.dev/ComPWA/sphinxcontrib-hep-pdgref)
-[![GitPod](https://img.shields.io/badge/gitpod-open-blue?logo=gitpod)](https://gitpod.io/#https://github.com/ComPWA/sphinxcontrib-hep-pdgref)
+[![Open in Visual Studio Code](https://img.shields.io/badge/vscode-open-blue?logo=visualstudiocode)](https://open.vscode.dev/ComPWA/sphinx-hep-pdgref)
+[![GitPod](https://img.shields.io/badge/gitpod-open-blue?logo=gitpod)](https://gitpod.io/#https://github.com/ComPWA/sphinx-hep-pdgref)
 
 This package is part of the [ComPWA Organization](https://github.com/ComPWA). For more
 information about how to contribute to the packages, go to

diff --git a/README.md b/README.md
@@ -1,15 +1,15 @@
 # PDG role for Sphinx
 
-[![PyPI package](https://badge.fury.io/py/sphinxcontrib-hep-pdgref.svg)](https://pypi.org/project/sphinxcontrib-hep-pdgref)
-[![Supported Python versions](https://img.shields.io/pypi/pyversions/sphinxcontrib-hep-pdgref)](https://pypi.org/project/sphinxcontrib-hep-pdgref)
+[![PyPI package](https://badge.fury.io/py/sphinx-hep-pdgref.svg)](https://pypi.org/project/sphinx-hep-pdgref)
+[![Supported Python versions](https://img.shields.io/pypi/pyversions/sphinx-hep-pdgref)](https://pypi.org/project/sphinx-hep-pdgref)
 [![BSD 3-Clause license](https://img.shields.io/badge/License-BSD_3--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
-[![Open in Visual Studio Code](https://img.shields.io/badge/vscode-open-blue?logo=visualstudiocode)](https://open.vscode.dev/ComPWA/sphinxcontrib-hep-pdgref)
-[![GitPod](https://img.shields.io/badge/gitpod-open-blue?logo=gitpod)](https://gitpod.io/#https://github.com/ComPWA/sphinxcontrib-hep-pdgref)
-[![Test coverage](https://codecov.io/gh/ComPWA/sphinxcontrib-hep-pdgref/branch/main/graph/badge.svg?token=SS8ZB8J11N)](https://codecov.io/gh/ComPWA/sphinxcontrib-hep-pdgref)
-[![Codacy Badge](https://app.codacy.com/project/badge/Grade/dbe042deb2914f6098eb98586d3983fe)](https://www.codacy.com/gh/ComPWA/sphinxcontrib-hep-pdgref)
-[![CI status](https://github.com/ComPWA/sphinxcontrib-hep-pdgref/workflows/CI-tests/badge.svg)](https://github.com/ComPWA/sphinxcontrib-hep-pdgref/actions?query=branch%3Amain+workflow%3ACI-tests)
+[![Open in Visual Studio Code](https://img.shields.io/badge/vscode-open-blue?logo=visualstudiocode)](https://open.vscode.dev/ComPWA/sphinx-hep-pdgref)
+[![GitPod](https://img.shields.io/badge/gitpod-open-blue?logo=gitpod)](https://gitpod.io/#https://github.com/ComPWA/sphinx-hep-pdgref)
+[![Test coverage](https://codecov.io/gh/ComPWA/sphinx-hep-pdgref/branch/main/graph/badge.svg?token=SS8ZB8J11N)](https://codecov.io/gh/ComPWA/sphinx-hep-pdgref)
+[![Codacy Badge](https://app.codacy.com/project/badge/Grade/dbe042deb2914f6098eb98586d3983fe)](https://www.codacy.com/gh/ComPWA/sphinx-hep-pdgref)
+[![CI status](https://github.com/ComPWA/sphinx-hep-pdgref/workflows/CI-tests/badge.svg)](https://github.com/ComPWA/sphinx-hep-pdgref/actions?query=branch%3Amain+workflow%3ACI-tests)
 [![Checked with mypy](http://www.mypy-lang.org/static/mypy_badge.svg)](https://mypy.readthedocs.io)
-[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/ComPWA/sphinxcontrib-hep-pdgref/main.svg)](https://results.pre-commit.ci/latest/github/ComPWA/sphinxcontrib-hep-pdgref/main)
+[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/ComPWA/sphinx-hep-pdgref/main.svg)](https://results.pre-commit.ci/latest/github/ComPWA/sphinx-hep-pdgref/main)
 [![Spelling checked](https://img.shields.io/badge/cspell-checked-brightgreen.svg)](https://github.com/streetsidesoftware/cspell/tree/master/packages/cspell)
 [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
@@ -24,17 +24,17 @@ that makes it easy to refer to PDF files of reviews and particle listings in the
 Just install through [PyPI](https://pypi.org) with `pip`:
 
 ```bash
-pip install sphinxcontrib-hep-pdgref
+pip install sphinx-hep-pdgref
 ```
 
 Next, in your
 [Sphinx configuration file](https://www.sphinx-doc.org/en/master/usage/configuration.html)
-(`conf.py`), add `"sphinxcontrib.hep.pdgref"` to your `extensions`:
+(`conf.py`), add `"sphinx_hep_pdgref"` to your `extensions`:
 
 ```python
 extensions = [
     # ...
-    "sphinxcontrib.hep.pdgref",
+    "sphinx_hep_pdgref",
     # ...
 ]
 ```

diff --git a/environment.yml b/environment.yml
@@ -1,4 +1,4 @@
-name: sphinxcontrib-hep-pdgref
+name: sphinx-hep-pdgref
 channels:
   - defaults
 dependencies:

diff --git a/pyproject.toml b/pyproject.toml
@@ -81,6 +81,7 @@ reportUnknownArgumentType = false
 reportUnknownMemberType = false
 reportUnknownParameterType = false
 reportUnknownVariableType = false
+reportUntypedFunctionDecorator = false
 reportUnusedClass = true
 reportUnusedFunction = true
 reportUnusedImport = true

diff --git a/setup.cfg b/setup.cfg
@@ -1,16 +1,16 @@
 [metadata]
-name = sphinxcontrib-hep-pdgref
+name = sphinx-hep-pdgref
 author = Common Partial Wave Analysis
 author_email = compwa-admin@ep1.rub.de
 maintainer_email = compwa-admin@ep1.rub.de
 description = Sphinx role for linking to PDG reviews and listing
 long_description = file: README.md
 long_description_content_type = text/markdown
 project_urls =
-    Tracker = https://github.com/ComPWA/sphinxcontrib-hep-pdgref/issues
-    Changelog = https://github.com/ComPWA/sphinxcontrib-hep-pdgref/releases
-    Documentation = https://github.com/ComPWA/sphinxcontrib-hep-pdgref/blob/main/README.md
-    Source = https://github.com/ComPWA/sphinxcontrib-hep-pdgref
+    Tracker = https://github.com/ComPWA/sphinx-hep-pdgref/issues
+    Changelog = https://github.com/ComPWA/sphinx-hep-pdgref/releases
+    Documentation = https://github.com/ComPWA/sphinx-hep-pdgref/blob/main/README.md
+    Source = https://github.com/ComPWA/sphinx-hep-pdgref
 license = BSD 3-Clause License
 license_files = LICENSE
 keywords =
@@ -44,13 +44,13 @@ install_requires =
     docutils
     Sphinx
 include_package_data = True
-namespace_packages = sphinxcontrib
 package_dir =
     =src
-packages = find_namespace:
+packages = find:
 
 [options.extras_require]
 test =
+    importlib-metadata; python_version <"3.8.0"
     pyquery  # for checking HTML output
     pytest
     pytest-cov
@@ -75,8 +75,6 @@ dev =
     tox >=1.9  # for skip_install, use_develop
 
 [options.packages.find]
-include =
-    sphinxcontrib.hep.*
 where = src
 
 [options.package_data]

diff --git a/src/sphinxcontrib/hep/pdgref/__init__.py → src/sphinx_hep_pdgref/__init__.py b/src/sphinxcontrib/hep/pdgref/__init__.py → src/sphinx_hep_pdgref/__init__.py
diff --git a/src/sphinxcontrib/hep/pdgref/entry.py → src/sphinx_hep_pdgref/entry.py b/src/sphinxcontrib/hep/pdgref/entry.py → src/sphinx_hep_pdgref/entry.py
@@ -40,7 +40,7 @@ def __attrs_post_init__(self) -> None:
     def from_str(text: str) -> "PDGEntry":
         """Create an entry from the contents of the :code:`pdg` role.
 
-        >>> from sphinxcontrib.hep.pdgref.entry import PDGEntry
+        >>> from sphinx_hep_pdgref.entry import PDGEntry
         >>> PDGEntry.from_str("Resonances; 2018; p.5")
         PDGEntry(section='Resonances', year=2018, pages='5')
         >>> PDGEntry.from_str("Resonances")

diff --git a/src/sphinxcontrib/hep/pdgref/py.typed → src/sphinx_hep_pdgref/py.typed b/src/sphinxcontrib/hep/pdgref/py.typed → src/sphinx_hep_pdgref/py.typed
diff --git a/src/sphinxcontrib/hep/pdgref/role.py → src/sphinx_hep_pdgref/role.py b/src/sphinxcontrib/hep/pdgref/role.py → src/sphinx_hep_pdgref/role.py
diff --git a/src/sphinxcontrib/hep/pdgref/url.py → src/sphinx_hep_pdgref/url.py b/src/sphinxcontrib/hep/pdgref/url.py → src/sphinx_hep_pdgref/url.py
diff --git a/src/sphinxcontrib/__init__.py b/src/sphinxcontrib/__init__.py
diff --git a/src/sphinxcontrib/hep/__init__.py b/src/sphinxcontrib/hep/__init__.py
diff --git a/tests/conftest.py b/tests/conftest.py
@@ -1,12 +1,28 @@
-# cspell:ignore rootdir
-from pathlib import Path
+import sys
 
 import pytest
 
+if sys.version_info < (3, 8):
+    from importlib_metadata import version
+else:
+    from importlib.metadata import version
+
 pytest_plugins = "sphinx.testing.fixtures"
 collect_ignore = ["roots"]
 
 
-@pytest.fixture(scope="session")
-def rootdir() -> Path:
-    return Path(__file__).parent.absolute() / "roots"
+# cspell:ignore rootdir
+sphinx_version = version("Sphinx")
+if sphinx_version < "7.2":
+    from sphinx.testing.path import path
+
+    @pytest.fixture(scope="session")
+    def rootdir() -> path:
+        return path(__file__).parent.abspath() / "roots"
+
+else:
+    from pathlib import Path
+
+    @pytest.fixture(scope="session")
+    def rootdir() -> Path:
+        return Path(__file__).parent.absolute() / "roots"
diff --git a/tests/roots/test-dummy/conf.py b/tests/roots/test-dummy/conf.py
@@ -1,2 +1,2 @@
-extensions = ["sphinxcontrib.hep.pdgref"]
+extensions = ["sphinx_hep_pdgref"]
 exclude_patterns = ["_build"]
diff --git a/tests/test_entry.py b/tests/test_entry.py
@@ -2,7 +2,7 @@
 
 import pytest
 
-from sphinxcontrib.hep.pdgref.entry import (
+from sphinx_hep_pdgref.entry import (
     DEFAULT_YEAR,
     PDGEntry,
     get_first_page,

diff --git a/tests/test_role.py b/tests/test_role.py
@@ -1,7 +1,7 @@
 import pyquery as pq  # pyright: ignore[reportMissingTypeStubs]
 import pytest
 
-from sphinxcontrib.hep.pdgref.entry import DEFAULT_YEAR  # type:ignore[import]
+from sphinx_hep_pdgref.entry import DEFAULT_YEAR  # type:ignore[import]
 
 
 @pytest.mark.sphinx("text", testroot="dummy")

diff --git a/tests/test_url.py b/tests/test_url.py
@@ -1,7 +1,7 @@
 import pytest
 
-from sphinxcontrib.hep.pdgref.entry import DEFAULT_YEAR, PDGEntry  # type:ignore[import]
-from sphinxcontrib.hep.pdgref.url import (  # type:ignore[import]
+from sphinx_hep_pdgref.entry import DEFAULT_YEAR, PDGEntry  # type:ignore[import]
+from sphinx_hep_pdgref.url import (  # type:ignore[import]
     URLPattern,
     create_link_text,
     create_url,

diff --git a/tox.ini b/tox.ini
@@ -18,7 +18,7 @@ commands =
         --cov-fail-under=90 \
         --cov-report=html \
         --cov-report=xml \
-        --cov=sphinxcontrib.hep.pdgref
+        --cov=sphinx_hep_pdgref
 
 [testenv:sty]
 description =