Merge branch 'sphinx-toolbox:master' into feature/query_homepage

Author: mathbou

.github/workflows/cleanup.yml

@@ -28,7 +28,7 @@ jobs:
           python -VV
           python -m site
           python -m pip install --upgrade pip setuptools wheel
-          python -m pip install --upgrade whey-conda
+          python -m pip install --upgrade "whey-conda" "whey"
           # $CONDA is an environment variable pointing to the root of the miniconda directory
           $CONDA/bin/conda update -q conda
           $CONDA/bin/conda install conda-build=3.21.0

.github/workflows/conda_ci.yml

@@ -17,7 +17,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout 🛎️
-        uses: "actions/checkout@v1"
+        uses: "actions/checkout@v2"
 
       - name: Check for changed files
         uses: dorny/paths-filter@v2

.github/workflows/docs_test_action.yml

@@ -21,7 +21,7 @@ jobs:
     runs-on: "windows-2019"
     continue-on-error: ${{ matrix.config.experimental }}
     env:
-      USING_COVERAGE: '3.6,3.7,3.8,3.9,3.10.0-rc.2,pypy-3.6,pypy-3.7'
+      USING_COVERAGE: '3.6,3.7,3.8,3.9,3.10,3.11.0-alpha.4,pypy-3.6,pypy-3.7,pypy-3.8'
 
     strategy:
       fail-fast: False
@@ -31,9 +31,11 @@ jobs:
           - {python-version: "3.7", testenvs: "py37,build", experimental: False}
           - {python-version: "3.8", testenvs: "py38,build", experimental: False}
           - {python-version: "3.9", testenvs: "py39,build", experimental: False}
-          - {python-version: "3.10.0-rc.2", testenvs: "py310-dev,build", experimental: True}
+          - {python-version: "3.10", testenvs: "py310,build", experimental: False}
+          - {python-version: "3.11.0-alpha.4", testenvs: "py311-dev,build", experimental: True}
           - {python-version: "pypy-3.6", testenvs: "pypy36,build", experimental: False}
           - {python-version: "pypy-3.7", testenvs: "pypy37,build", experimental: True}
+          - {python-version: "pypy-3.8", testenvs: "pypy38,build", experimental: True}
 
     steps:
       - name: Checkout 🛎️

.github/workflows/python_ci.yml

@@ -22,7 +22,7 @@ jobs:
     runs-on: "ubuntu-20.04"
     continue-on-error: ${{ matrix.config.experimental }}
     env:
-      USING_COVERAGE: '3.6,3.7,3.8,3.9,3.10.0-rc.2,pypy-3.6,pypy-3.7'
+      USING_COVERAGE: '3.6,3.7,3.8,3.9,3.10,3.11.0-alpha.4,pypy-3.6,pypy-3.7,pypy-3.8'
 
     strategy:
       fail-fast: False
@@ -32,9 +32,11 @@ jobs:
           - {python-version: "3.7", testenvs: "py37,build", experimental: False}
           - {python-version: "3.8", testenvs: "py38,build", experimental: False}
           - {python-version: "3.9", testenvs: "py39,build", experimental: False}
-          - {python-version: "3.10.0-rc.2", testenvs: "py310-dev,build", experimental: True}
+          - {python-version: "3.10", testenvs: "py310,build", experimental: False}
+          - {python-version: "3.11.0-alpha.4", testenvs: "py311-dev,build", experimental: True}
           - {python-version: "pypy-3.6", testenvs: "pypy36,build", experimental: False}
           - {python-version: "pypy-3.7", testenvs: "pypy37,build", experimental: True}
+          - {python-version: "pypy-3.8", testenvs: "pypy38,build", experimental: True}
 
     steps:
       - name: Checkout 🛎️
@@ -101,21 +103,26 @@ jobs:
           path: coverage
 
       - name: Display structure of downloaded files
+        id: show
         run: ls -R
         working-directory: coverage
+        continue-on-error: true
 
       - name: Combine Coverage 👷
+        if: ${{ steps.show.outcome != 'failure' }}
         run: |
           shopt -s globstar
           python -m coverage combine coverage/**/.coverage
 
       - name: "Upload Combined Coverage Artefact 🚀"
+        if: ${{ steps.show.outcome != 'failure' }}
         uses: actions/upload-artifact@v2
         with:
           name: "combined-coverage"
           path: .coverage
 
       - name: "Upload Combined Coverage to Coveralls"
+        if: ${{ steps.show.outcome != 'failure' }}
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: |
@@ -173,7 +180,7 @@ jobs:
       - name: Install dependencies 🔧
         run: |
           python -m pip install --upgrade pip setuptools wheel
-          python -m pip install --upgrade mkrecipe
+          python -m pip install --upgrade "mkrecipe" "whey"
 
           wget https://repo.anaconda.com/miniconda/Miniconda3-py38_4.10.3-Linux-x86_64.sh -O miniconda.sh
           bash miniconda.sh -b -p $HOME/miniconda

.github/workflows/python_ci_linux.yml

@@ -21,7 +21,7 @@ jobs:
     runs-on: "macos-latest"
     continue-on-error: ${{ matrix.config.experimental }}
     env:
-      USING_COVERAGE: '3.6,3.7,3.8,3.9,3.10.0-rc.2,pypy-3.6,pypy-3.7'
+      USING_COVERAGE: '3.6,3.7,3.8,3.9,3.10,3.11.0-alpha.4,pypy-3.7,pypy-3.8'
 
     strategy:
       fail-fast: False
@@ -31,9 +31,10 @@ jobs:
           - {python-version: "3.7", testenvs: "py37,build", experimental: False}
           - {python-version: "3.8", testenvs: "py38,build", experimental: False}
           - {python-version: "3.9", testenvs: "py39,build", experimental: False}
-          - {python-version: "3.10.0-rc.2", testenvs: "py310-dev,build", experimental: True}
-          - {python-version: "pypy-3.6", testenvs: "pypy36,build", experimental: False}
+          - {python-version: "3.10", testenvs: "py310,build", experimental: False}
+          - {python-version: "3.11.0-alpha.4", testenvs: "py311-dev,build", experimental: True}
           - {python-version: "pypy-3.7", testenvs: "pypy37,build", experimental: True}
+          - {python-version: "pypy-3.8", testenvs: "pypy38,build", experimental: True}
 
     steps:
       - name: Checkout 🛎️

.github/workflows/python_ci_macos.yml

@@ -30,7 +30,7 @@ repos:
     - id: end-of-file-fixer
 
  - repo: https://github.com/domdfcoding/pre-commit-hooks
-   rev: v0.2.1
+   rev: v0.3.0
    hooks:
     - id: requirements-txt-sorter
       args:
@@ -40,7 +40,7 @@ repos:
     - id: bind-requirements
 
  - repo: https://github.com/domdfcoding/flake8-dunder-all
-   rev: v0.1.7
+   rev: v0.1.8
    hooks:
     - id: ensure-dunder-all
       files: ^seed_intersphinx_mapping/.*\.py$
@@ -73,7 +73,7 @@ repos:
     - id: forbid-crlf
 
  - repo: https://github.com/python-formate/snippet-fmt
-   rev: v0.1.3
+   rev: v0.1.4
    hooks:
     - id: snippet-fmt
 

.pre-commit-config.yaml

@@ -109,7 +109,7 @@ seed_intersphinx_mapping
 	:target: https://github.com/sphinx-toolbox/seed_intersphinx_mapping/commit/master
 	:alt: GitHub last commit
 
-.. |maintained| image:: https://img.shields.io/maintenance/yes/2021
+.. |maintained| image:: https://img.shields.io/maintenance/yes/2022
 	:alt: Maintenance
 
 .. |pypi-downloads| image:: https://img.shields.io/pypi/dm/seed_intersphinx_mapping

README.rst

@@ -114,7 +114,7 @@ seed_intersphinx_mapping
 		:last-commit:
 		:alt: GitHub last commit
 
-	.. |maintained| maintained-shield:: 2021
+	.. |maintained| maintained-shield:: 2022
 		:alt: Maintenance
 
 	.. |pypi-downloads| pypi-shield::

__pkginfo__.py

@@ -2,6 +2,7 @@ git+https://github.com/sphinx-toolbox/sphinx-toolbox-experimental.git
 default-values>=0.5.0b1
 extras-require>=0.2.0
 furo>=2020.11.19b18
+html-section>=0.1.0
 seed-intersphinx-mapping>=0.3.1
 sphinx-copybutton>=0.2.12
 sphinx-debuginfo>=0.1.0

doc-source/index.rst

@@ -45,6 +45,7 @@ known_third_party = [
     "html5lib",
     "importlib_metadata",
     "importlib_resources",
+    "numpy",
     "packaging",
     "pypi_json",
     "pytest",

doc-source/requirements.txt

@@ -34,7 +34,7 @@ base-classifiers = [
     "Topic :: Software Development :: Documentation",
     "Typing :: Typed",
 ]
-python-versions = [ "3.6", "3.7", "3.8", "3.9",]
+python-versions = [ "3.6", "3.7", "3.8", "3.9", "3.10",]
 python-implementations = [ "CPython", "PyPy",]
 platforms = [ "Windows", "macOS", "Linux",]
 license-key = "MIT"
@@ -72,7 +72,7 @@ extensions = [
     "sphinx_debuginfo",
     "sphinx_licenseinfo",
     "seed_intersphinx_mapping",
-    "sphinx_toolbox_experimental.html_section",
+    "html_section",
     "sphinx_toolbox_experimental.autosummary_widths",
     "sphinx_toolbox_experimental.needspace",
     "sphinx_toolbox_experimental.peps",

formate.toml

@@ -25,9 +25,11 @@ python_versions:
  - '3.7'
  - '3.8'
  - '3.9'
- - 3.10-dev
+ - "3.10"
+ - 3.11-dev
  - pypy36
  - pypy37
+ - pypy38
 
 manifest_additional:
  - "include seed_intersphinx_mapping/fallback_mapping.json"
@@ -51,11 +53,13 @@ exclude_files:
 preserve_custom_theme: true
 
 extra_sphinx_extensions:
- - sphinx_toolbox_experimental.html_section
  - sphinx_toolbox_experimental.autosummary_widths
  - sphinx_toolbox_experimental.needspace
  - sphinx_toolbox_experimental.peps
 
 sphinx_conf_epilogue:
  - "	from sphinx_toolbox.latex import replace_unknown_unicode"
  - '	app.connect("build-finished", replace_unknown_unicode)'
+
+tox_unmanaged:
+ - testenv

pyproject.toml

@@ -1,35 +1,37 @@
 {
-  "slumber": "https://slumber.readthedocs.io/en/v0.6.0/",
-  "packaging": "https://packaging.pypa.io/en/latest/",
-  "importlib_resources": "https://importlib-resources.readthedocs.io/en/latest/",
-  "importlib-resources": "https://importlib-resources.readthedocs.io/en/latest/",
-  "sphinx": "https://www.sphinx-doc.org/en/3.x/",
-  "typing_extensions": "https://docs.python.org/3/",
-  "typing-extensions": "https://docs.python.org/3/",
-  "pandas": "https://pandas.pydata.org/docs/",
-  "pytest": "https://docs.pytest.org/en/stable",
-  "natsort": "https://natsort.readthedocs.io/en/master/",
-  "pydash": "https://pydash.readthedocs.io/en/latest/",
-  "pytest-regressions": "https://pytest-regressions.readthedocs.io/en/latest/",
+  "babel": "https://babel.readthedocs.io/en/latest/",
   "boto3": "https://boto3.amazonaws.com/v1/documentation/api/latest/",
-  "chardet": "https://chardet.readthedocs.io/en/latest",
-  "six": "https://six.readthedocs.io/",
+  "cachetools": "https://cachetools.readthedocs.io/en/latest/",
   "cffi": "https://cffi.readthedocs.io/en/latest/",
+  "chardet": "https://chardet.readthedocs.io/en/latest",
   "cryptography": "https://cryptography.io/en/latest/",
-  "python-dateutil": "https://dateutil.readthedocs.io/en/stable/",
-  "pyparsing": "https://pyparsing-docs.readthedocs.io/en/latest/",
-  "requests-oauthlib": "https://requests-oauthlib.readthedocs.io/en/latest/",
-  "oauthlib": "https://oauthlib.readthedocs.io/en/latest/",
-  "pyopenssl": "https://www.pyopenssl.org/en/latest/",
+  "dnspython": "https://dnspython.readthedocs.io/en/latest/",
   "importlib-metadata": "https://importlib-metadata.readthedocs.io/en/latest/",
+  "importlib-resources": "https://importlib-resources.readthedocs.io/en/latest/",
   "importlib_metadata": "https://importlib-metadata.readthedocs.io/en/latest/",
+  "importlib_resources": "https://importlib-resources.readthedocs.io/en/latest/",
+  "natsort": "https://natsort.readthedocs.io/en/master/",
+  "numpy": "https://numpy.org/doc/stable/",
+  "oauthlib": "https://oauthlib.readthedocs.io/en/latest/",
+  "packaging": "https://packaging.pypa.io/en/latest/",
+  "pandas": "https://pandas.pydata.org/docs/",
   "psutil": "https://psutil.readthedocs.io/en/latest/",
-  "zipp": "https://zipp.readthedocs.io/en/latest/",
-  "yarl": "https://yarl.readthedocs.io/en/latest/",
-  "cachetools": "https://cachetools.readthedocs.io/en/latest/",
+  "pydash": "https://pydash.readthedocs.io/en/latest/",
   "pyjwt": "https://pyjwt.readthedocs.io/en/latest/",
-  "dnspython": "https://dnspython.readthedocs.io/en/latest/",
-  "babel": "https://babel.readthedocs.io/en/latest/",
+  "pyopenssl": "https://www.pyopenssl.org/en/latest/",
+  "pyparsing": "https://pyparsing-docs.readthedocs.io/en/latest/",
   "pyrsistent": "https://pyrsistent.readthedocs.io/en/latest/",
-  "scikit-learn": "https://scikit-learn.org/stable/"
+  "pytest": "https://docs.pytest.org/en/stable",
+  "pytest-regressions": "https://pytest-regressions.readthedocs.io/en/latest/",
+  "python-dateutil": "https://dateutil.readthedocs.io/en/stable/",
+  "requests-oauthlib": "https://requests-oauthlib.readthedocs.io/en/latest/",
+  "scikit-learn": "https://scikit-learn.org/stable/",
+  "six": "https://six.readthedocs.io/",
+  "slumber": "https://slumber.readthedocs.io/en/v0.6.0/",
+  "sphinx": "https://www.sphinx-doc.org/en/3.x/",
+  "typing": "https://docs.python.org/3/",
+  "typing-extensions": "https://docs.python.org/3/",
+  "typing_extensions": "https://docs.python.org/3/",
+  "yarl": "https://yarl.readthedocs.io/en/latest/",
+  "zipp": "https://zipp.readthedocs.io/en/latest/"
 }

repo_helper.yml

@@ -3,6 +3,7 @@ coverage>=5.1
 coverage-pyver-pragma>=0.2.1
 html5lib>=1.1
 importlib-metadata>=3.6.0
+numpy~=1.22.0; python_version >= "3.8"
 pytest>=6.0.0
 pytest-cov>=2.8.1
 pytest-datafiles>=2.0

seed_intersphinx_mapping/fallback_mapping.json

@@ -31,6 +31,8 @@ def test_get_sphinx_doc_url():
 	with pytest.raises(ValueError, match="Documentation URL not found in data from PyPI."):
 		get_sphinx_doc_url("sphinx-prompt")
 
+	assert get_sphinx_doc_url("numpy") in {"https://numpy.org/doc/1.22/", "https://numpy.org/doc/1.21/"}
+
 
 def test_get_sphinx_doc_url_wrapping():
 	assert get_sphinx_doc_url.__name__ == "get_sphinx_doc_url"

tests/requirements.txt

@@ -4,7 +4,7 @@
 
 
 @pytest.fixture()
-def requirements(tmp_pathplus):
+def requirements(tmp_pathplus: PathPlus) -> None:
 	fake_repo_root = tmp_pathplus.parent
 
 	(fake_repo_root / "requirements.txt").write_text("""\
@@ -16,7 +16,8 @@ def requirements(tmp_pathplus):
 """)
 
 
-def test_integration(requirements, the_app):
+@pytest.mark.usefixtures("requirements")
+def test_integration(the_app):
 	# app is a Sphinx application object for default sphinx project (`tests/doc-test/test-root`).
 	the_app.build()