Merge branch 'master' into pre-commit-ci-update-config

.bumpversion.cfg

@@ -13,4 +13,7 @@ tag = True
 
 [bumpversion:file:seed_intersphinx_mapping/__init__.py]
 
+search = : str = "{current_version}"
+replace = : str = "{new_version}"
+
 [bumpversion:file:pyproject.toml]

.github/ISSUE_TEMPLATE/bug_report.md

@@ -17,7 +17,10 @@ THE ISSUE WILL BE CLOSED IF INSUFFICIENT INFORMATION IS PROVIDED.
 
 
 ## Steps to Reproduce
-<!--Please add a series of steps to reproduce the issue-->
+<!--Please add a series of steps to reproduce the issue.
+
+If possible, please include a small, self-contained reproduction.
+-->
 
    1.
    2.

.github/workflows/conda_ci.yml

@@ -4,7 +4,6 @@ name: Conda Tests
 
 on:
   push:
-  pull_request:
     branches: ["master"]
 
 jobs:

.github/workflows/docs_test_action.yml

@@ -2,7 +2,6 @@
 ---
 name: "Docs Check"
 on:
-  - pull_request
   - push
 
 jobs:

.github/workflows/flake8.yml

@@ -4,8 +4,6 @@ name: Flake8
 
 on:
   push:
-  pull_request:
-    branches: ["master"]
 
 jobs:
   Run:

.github/workflows/mypy.yml

@@ -4,8 +4,6 @@ name: mypy
 
 on:
   push:
-  pull_request:
-    branches: ["master"]
 
 jobs:
   Run:
@@ -14,7 +12,7 @@ jobs:
 
     strategy:
       matrix:
-        os: ['windows-2019', 'macos-latest', 'ubuntu-20.04']
+        os: ['ubuntu-20.04', 'windows-2019']
       fail-fast: false
 
     steps:

.github/workflows/python_ci.yml

@@ -4,16 +4,14 @@ name: Windows
 
 on:
   push:
-  pull_request:
-    branches: ["master"]
 
 jobs:
   tests:
     name: "windows-2019 / Python ${{ matrix.config.python-version }}"
     runs-on: "windows-2019"
     continue-on-error: ${{ matrix.config.experimental }}
     env:
-      USING_COVERAGE: '3.6,3.7,3.8,3.9,3.10.0-alpha.5,pypy-3.6,pypy-3.7'
+      USING_COVERAGE: '3.6,3.7,3.8,3.9,3.10.0-alpha.6,pypy-3.6,pypy-3.7'
 
     strategy:
       fail-fast: False
@@ -23,9 +21,9 @@ 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-alpha.5", testenvs: "py310-dev,build", experimental: True}
+          - {python-version: "3.10.0-alpha.6", testenvs: "py310-dev,build", experimental: True}
           - {python-version: "pypy-3.6", testenvs: "pypy36,build", experimental: False}
-          - {python-version: "pypy-3.7", testenvs: "pypy37,build", experimental: False}
+          - {python-version: "pypy-3.7", testenvs: "pypy37,build", experimental: True}
 
     steps:
       - name: Checkout 🛎️

.github/workflows/python_ci_linux.yml

@@ -4,16 +4,14 @@ name: Linux
 
 on:
   push:
-  pull_request:
-    branches: ["master"]
 
 jobs:
   tests:
     name: "ubuntu-20.04 / Python ${{ matrix.config.python-version }}"
     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-alpha.5,pypy-3.6,pypy-3.7'
+      USING_COVERAGE: '3.6,3.7,3.8,3.9,3.10.0-alpha.6,pypy-3.6,pypy-3.7'
 
     strategy:
       fail-fast: False
@@ -23,9 +21,9 @@ 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-alpha.5", testenvs: "py310-dev,build", experimental: True}
+          - {python-version: "3.10.0-alpha.6", testenvs: "py310-dev,build", experimental: True}
           - {python-version: "pypy-3.6", testenvs: "pypy36,build", experimental: False}
-          - {python-version: "pypy-3.7", testenvs: "pypy37,build", experimental: False}
+          - {python-version: "pypy-3.7", testenvs: "pypy37,build", experimental: True}
 
     steps:
       - name: Checkout 🛎️
@@ -127,7 +125,7 @@ jobs:
 
       - name: Upload distribution to PyPI 🚀
         if: startsWith(github.ref, 'refs/tags/')
-        uses: pypa/gh-action-pypi-publish@master
+        uses: pypa/gh-action-pypi-publish@v1.4.2
         with:
           user: __token__
           password: ${{ secrets.PYPI_TOKEN }}

.github/workflows/python_ci_macos.yml

@@ -4,16 +4,14 @@ name: macOS
 
 on:
   push:
-  pull_request:
-    branches: ["master"]
 
 jobs:
   tests:
     name: "macos-latest / Python ${{ matrix.config.python-version }}"
     runs-on: "macos-latest"
     continue-on-error: ${{ matrix.config.experimental }}
     env:
-      USING_COVERAGE: '3.6,3.7,3.8,3.9,3.10.0-alpha.5,pypy-3.6,pypy-3.7'
+      USING_COVERAGE: '3.6,3.7,3.8,3.9,3.10.0-alpha.6,pypy-3.6,pypy-3.7'
 
     strategy:
       fail-fast: False
@@ -23,9 +21,9 @@ 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-alpha.5", testenvs: "py310-dev,build", experimental: True}
+          - {python-version: "3.10.0-alpha.6", testenvs: "py310-dev,build", experimental: True}
           - {python-version: "pypy-3.6", testenvs: "pypy36,build", experimental: False}
-          - {python-version: "pypy-3.7", testenvs: "pypy37,build", experimental: False}
+          - {python-version: "pypy-3.7", testenvs: "pypy37,build", experimental: True}
 
     steps:
       - name: Checkout 🛎️

.readthedocs.yml

@@ -5,7 +5,9 @@ version: 2
 sphinx:
   builder: html
   configuration: doc-source/conf.py
-formats: all
+formats:
+ - pdf
+ - htmlzip
 python:
   version: 3.8
   install:

__pkginfo__.py

@@ -29,4 +29,4 @@
 __version__ = "0.4.0"
 repo_root = pathlib.Path(__file__).parent
 install_requires = (repo_root / "requirements.txt").read_text(encoding="utf-8").split('\n')
-extras_require = {"all": []}
+extras_require = {}

doc-source/_static/style.css

@@ -1,6 +1,10 @@
 /* This file is managed by 'repo_helper'. Don't edit it directly. */
 
 div.highlight {
-    -moz-tab-size: 4; /* Firefox */
-    tab-size: 4;
+	-moz-tab-size: 4;
+	tab-size: 4;
+}
+
+.field-list dt, dl.simple dt {
+	margin-top: 0.5rem;
 }

doc-source/conf.py

@@ -23,7 +23,7 @@
 """
 
 author = "Dominic Davis-Foster"
-project = "seed_intersphinx_mapping"
+project = "seed_intersphinx_mapping".replace('_', '-')
 slug = re.sub(r'\W+', '-', project.lower())
 release = version = __version__
 copyright = "2020-2021 Dominic Davis-Foster"  # pylint: disable=redefined-builtin
@@ -34,7 +34,9 @@
 		"sphinx_toolbox",
 		"sphinx_toolbox.more_autodoc",
 		"sphinx_toolbox.more_autosummary",
+		"sphinx_toolbox.documentation_summary",
 		"sphinx_toolbox.tweaks.param_dash",
+		"sphinx_toolbox.tweaks.latex_toc",
 		"sphinx.ext.intersphinx",
 		"sphinx.ext.mathjax",
 		"sphinxcontrib.httpdomain",
@@ -109,7 +111,7 @@
 hide_none_rtype = True
 all_typevars = True
 overloads_location = "bottom"
-
+documentation_summary = "Populate the Sphinx 'intersphinx_mapping' dictionary from the project's requirements."
 
 autodoc_exclude_members = [   # Exclude "standard" methods.
 		"__dict__",