Merge c2d6f92 into 53f0c84

.bumpversion.cfg

@@ -12,3 +12,5 @@ tag = True
 [bumpversion:file:doc-source/index.rst]
 
 [bumpversion:file:mh_utils/__init__.py]
+
+[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/python_ci.yml

@@ -13,7 +13,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-alpha.5'
+      USING_COVERAGE: '3.6,3.7,3.8,3.9,3.10.0-alpha.6'
 
     strategy:
       fail-fast: False
@@ -23,7 +23,7 @@ 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}
 
     steps:
       - name: Checkout 🛎️

.github/workflows/python_ci_linux.yml

@@ -13,7 +13,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-alpha.5'
+      USING_COVERAGE: '3.6,3.7,3.8,3.9,3.10.0-alpha.6'
 
     strategy:
       fail-fast: False
@@ -23,7 +23,7 @@ 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}
 
     steps:
       - name: Checkout 🛎️

.github/workflows/python_ci_macos.yml

@@ -13,7 +13,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-alpha.5'
+      USING_COVERAGE: '3.6,3.7,3.8,3.9,3.10.0-alpha.6'
 
     strategy:
       fail-fast: False
@@ -23,7 +23,7 @@ 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}
 
     steps:
       - name: Checkout 🛎️

.pre-commit-config.yaml

@@ -68,7 +68,7 @@ repos:
     - id: forbid-crlf
 
  - repo: https://github.com/repo-helper/formate
-   rev: v0.4.2
+   rev: v0.4.3
    hooks:
     - id: formate
       exclude: ^(doc-source/conf|__pkginfo__|make_conda_recipe|setup)\.(_)?py$

.pylintrc

@@ -66,7 +66,7 @@ confidence=
 # no Warning level messages displayed, use"--disable=all --enable=classes
 # --disable=W"
 disable=all
-enable=assert-on-tuple,astroid-error,bad-except-order,bad-inline-option,bad-option-value,bad-reversed-sequence,bare-except,binary-op-exception,boolean-datetime,catching-non-exception,cell-var-from-loop,confusing-with-statement,consider-merging-isinstance,consider-using-enumerate,consider-using-ternary,continue-in-finally,cyclic-import,deprecated-pragma,django-not-available,duplicate-except,duplicate-key,eval-used,exec-used,expression-not-assigned,fatal,file-ignored,fixme,global-at-module-level,global-statement,global-variable-not-assigned,global-variable-undefined,http-response-with-content-type-json,http-response-with-json-dumps,invalid-all-object,invalid-characters-in-docstring,len-as-condition,literal-comparison,locally-disabled,locally-enabled,lost-exception,lowercase-l-suffix,misplaced-bare-raise,missing-kwoa,mixed-line-endings,model-has-unicode,model-missing-unicode,model-no-explicit-unicode,model-unicode-not-callable,multiple-imports,multiple-statements,new-db-field-with-default,non-ascii-bytes-literals,nonexistent-operator,not-in-loop,notimplemented-raised,overlapping-except,parse-error,pointless-statement,pointless-string-statement,raising-bad-type,raising-non-exception,raw-checker-failed,redefine-in-handler,redefined-argument-from-local,redefined-builtin,redundant-content-type-for-json-response,reimported,relative-import,return-outside-function,simplifiable-if-statement,singleton-comparison,syntax-error,trailing-comma-tuple,trailing-newlines,unbalanced-tuple-unpacking,undefined-all-variable,undefined-loop-variable,unexpected-line-ending-format,unidiomatic-typecheck,unnecessary-lambda,unnecessary-pass,unnecessary-semicolon,unneeded-not,unpacking-non-sequence,unreachable,unrecognized-inline-option,used-before-assignment,useless-else-on-loop,using-constant-test,wildcard-import,yield-outside-function,useless-return
+enable=assert-on-tuple,astroid-error,bad-except-order,bad-inline-option,bad-option-value,bad-reversed-sequence,bare-except,binary-op-exception,boolean-datetime,catching-non-exception,cell-var-from-loop,confusing-with-statement,consider-merging-isinstance,consider-using-enumerate,consider-using-ternary,continue-in-finally,cyclic-import,deprecated-pragma,django-not-available,duplicate-except,duplicate-key,eval-used,exec-used,expression-not-assigned,fatal,file-ignored,fixme,global-at-module-level,global-statement,global-variable-not-assigned,global-variable-undefined,http-response-with-content-type-json,http-response-with-json-dumps,invalid-all-object,invalid-characters-in-docstring,len-as-condition,literal-comparison,locally-disabled,locally-enabled,lost-exception,lowercase-l-suffix,misplaced-bare-raise,missing-kwoa,mixed-line-endings,model-has-unicode,model-missing-unicode,model-no-explicit-unicode,model-unicode-not-callable,multiple-imports,new-db-field-with-default,non-ascii-bytes-literals,nonexistent-operator,not-in-loop,notimplemented-raised,overlapping-except,parse-error,pointless-statement,pointless-string-statement,raising-bad-type,raising-non-exception,raw-checker-failed,redefine-in-handler,redefined-argument-from-local,redefined-builtin,redundant-content-type-for-json-response,reimported,relative-import,return-outside-function,simplifiable-if-statement,singleton-comparison,syntax-error,trailing-comma-tuple,trailing-newlines,unbalanced-tuple-unpacking,undefined-all-variable,undefined-loop-variable,unexpected-line-ending-format,unidiomatic-typecheck,unnecessary-lambda,unnecessary-pass,unnecessary-semicolon,unneeded-not,unpacking-non-sequence,unreachable,unrecognized-inline-option,used-before-assignment,useless-else-on-loop,using-constant-test,wildcard-import,yield-outside-function,useless-return
 
 [REPORTS]
 

.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

@@ -27,7 +27,6 @@
 """
 
 __version__ = "0.2.1"
-
 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/conf.py

@@ -23,7 +23,7 @@
 """
 
 author = "Dominic Davis-Foster"
-project = "mh_utils"
+project = "mh_utils".replace('_', '-')
 slug = re.sub(r'\W+', '-', project.lower())
 release = version = __version__
 copyright = "2020-2021 Dominic Davis-Foster"  # pylint: disable=redefined-builtin
@@ -35,6 +35,7 @@
 		"sphinx_toolbox.more_autodoc",
 		"sphinx_toolbox.more_autosummary",
 		"sphinx_toolbox.tweaks.param_dash",
+		"sphinx_toolbox.tweaks.latex_toc",
 		"sphinx.ext.intersphinx",
 		"sphinx.ext.mathjax",
 		"sphinxcontrib.httpdomain",
@@ -45,6 +46,7 @@
 		"sphinx_copybutton",
 		"sphinxcontrib.default_values",
 		"sphinxcontrib.toctree_plus",
+		"sphinx_debuginfo",
 		"seed_intersphinx_mapping",
 		"enum_tools.autoenum",
 		"attr_utils.autoattrs",

doc-source/index.rst

@@ -10,116 +10,118 @@ mh_utils
 
 .. start shields
 
-.. list-table::
-	:stub-columns: 1
-	:widths: 10 90
-
-	* - Docs
-	  - |docs| |docs_check|
-	* - Tests
-	  - |actions_linux| |actions_windows| |actions_macos| |coveralls|
-	* - PyPI
-	  - |pypi-version| |supported-versions| |supported-implementations| |wheel|
-	* - Anaconda
-	  - |conda-version| |conda-platform|
-	* - Activity
-	  - |commits-latest| |commits-since| |maintained| |pypi-downloads|
-	* - QA
-	  - |codefactor| |actions_flake8| |actions_mypy| |pre_commit_ci|
-	* - Other
-	  - |license| |language| |requires|
-
-.. |docs| rtfd-shield::
-	:project: mh_utils
-	:alt: Documentation Build Status
-
-.. |docs_check| actions-shield::
-	:workflow: Docs Check
-	:alt: Docs Check Status
-
-.. |actions_linux| actions-shield::
-	:workflow: Linux
-	:alt: Linux Test Status
-
-.. |actions_windows| actions-shield::
-	:workflow: Windows
-	:alt: Windows Test Status
-
-.. |actions_macos| actions-shield::
-	:workflow: macOS
-	:alt: macOS Test Status
-
-.. |actions_flake8| actions-shield::
-	:workflow: Flake8
-	:alt: Flake8 Status
-
-.. |actions_mypy| actions-shield::
-	:workflow: mypy
-	:alt: mypy status
-
-.. |requires| requires-io-shield::
-	:alt: Requirements Status
-
-.. |coveralls| coveralls-shield::
-	:alt: Coverage
-
-.. |codefactor| codefactor-shield::
-	:alt: CodeFactor Grade
-
-.. |pypi-version| pypi-shield::
-	:project: mh_utils
-	:version:
-	:alt: PyPI - Package Version
-
-.. |supported-versions| pypi-shield::
-	:project: mh_utils
-	:py-versions:
-	:alt: PyPI - Supported Python Versions
-
-.. |supported-implementations| pypi-shield::
-	:project: mh_utils
-	:implementations:
-	:alt: PyPI - Supported Implementations
-
-.. |wheel| pypi-shield::
-	:project: mh_utils
-	:wheel:
-	:alt: PyPI - Wheel
-
-.. |conda-version| image:: https://img.shields.io/conda/v/domdfcoding/mh_utils?logo=anaconda
-	:target: https://anaconda.org/domdfcoding/mh_utils
-	:alt: Conda - Package Version
-
-.. |conda-platform| image:: https://img.shields.io/conda/pn/domdfcoding/mh_utils?label=conda%7Cplatform
-	:target: https://anaconda.org/domdfcoding/mh_utils
-	:alt: Conda - Platform
-
-.. |license| github-shield::
-	:license:
-	:alt: License
-
-.. |language| github-shield::
-	:top-language:
-	:alt: GitHub top language
-
-.. |commits-since| github-shield::
-	:commits-since: v0.2.1
-	:alt: GitHub commits since tagged version
-
-.. |commits-latest| github-shield::
-	:last-commit:
-	:alt: GitHub last commit
-
-.. |maintained| maintained-shield:: 2021
-	:alt: Maintenance
-
-.. |pypi-downloads| pypi-shield::
-	:project: mh_utils
-	:downloads: month
-	:alt: PyPI - Downloads
-
-.. |pre_commit_ci| pre-commit-ci-shield::
-	:alt: pre-commit.ci status
+.. only:: html
+
+	.. list-table::
+		:stub-columns: 1
+		:widths: 10 90
+
+		* - Docs
+		  - |docs| |docs_check|
+		* - Tests
+		  - |actions_linux| |actions_windows| |actions_macos| |coveralls|
+		* - PyPI
+		  - |pypi-version| |supported-versions| |supported-implementations| |wheel|
+		* - Anaconda
+		  - |conda-version| |conda-platform|
+		* - Activity
+		  - |commits-latest| |commits-since| |maintained| |pypi-downloads|
+		* - QA
+		  - |codefactor| |actions_flake8| |actions_mypy| |pre_commit_ci|
+		* - Other
+		  - |license| |language| |requires|
+
+	.. |docs| rtfd-shield::
+		:project: mh_utils
+		:alt: Documentation Build Status
+
+	.. |docs_check| actions-shield::
+		:workflow: Docs Check
+		:alt: Docs Check Status
+
+	.. |actions_linux| actions-shield::
+		:workflow: Linux
+		:alt: Linux Test Status
+
+	.. |actions_windows| actions-shield::
+		:workflow: Windows
+		:alt: Windows Test Status
+
+	.. |actions_macos| actions-shield::
+		:workflow: macOS
+		:alt: macOS Test Status
+
+	.. |actions_flake8| actions-shield::
+		:workflow: Flake8
+		:alt: Flake8 Status
+
+	.. |actions_mypy| actions-shield::
+		:workflow: mypy
+		:alt: mypy status
+
+	.. |requires| requires-io-shield::
+		:alt: Requirements Status
+
+	.. |coveralls| coveralls-shield::
+		:alt: Coverage
+
+	.. |codefactor| codefactor-shield::
+		:alt: CodeFactor Grade
+
+	.. |pypi-version| pypi-shield::
+		:project: mh_utils
+		:version:
+		:alt: PyPI - Package Version
+
+	.. |supported-versions| pypi-shield::
+		:project: mh_utils
+		:py-versions:
+		:alt: PyPI - Supported Python Versions
+
+	.. |supported-implementations| pypi-shield::
+		:project: mh_utils
+		:implementations:
+		:alt: PyPI - Supported Implementations
+
+	.. |wheel| pypi-shield::
+		:project: mh_utils
+		:wheel:
+		:alt: PyPI - Wheel
+
+	.. |conda-version| image:: https://img.shields.io/conda/v/domdfcoding/mh_utils?logo=anaconda
+		:target: https://anaconda.org/domdfcoding/mh_utils
+		:alt: Conda - Package Version
+
+	.. |conda-platform| image:: https://img.shields.io/conda/pn/domdfcoding/mh_utils?label=conda%7Cplatform
+		:target: https://anaconda.org/domdfcoding/mh_utils
+		:alt: Conda - Platform
+
+	.. |license| github-shield::
+		:license:
+		:alt: License
+
+	.. |language| github-shield::
+		:top-language:
+		:alt: GitHub top language
+
+	.. |commits-since| github-shield::
+		:commits-since: v0.2.1
+		:alt: GitHub commits since tagged version
+
+	.. |commits-latest| github-shield::
+		:last-commit:
+		:alt: GitHub last commit
+
+	.. |maintained| maintained-shield:: 2021
+		:alt: Maintenance
+
+	.. |pypi-downloads| pypi-shield::
+		:project: mh_utils
+		:downloads: month
+		:alt: PyPI - Downloads
+
+	.. |pre_commit_ci| pre-commit-ci-shield::
+		:alt: pre-commit.ci status
 
 .. end shields
 
@@ -163,8 +165,10 @@ Installation
 
 .. start links
 
-View the :ref:`Function Index <genindex>` or browse the `Source Code <_modules/index.html>`__.
+.. only:: html
 
-`Browse the GitHub Repository <https://github.com/domdfcoding/mh_utils>`__
+	View the :ref:`Function Index <genindex>` or browse the `Source Code <_modules/index.html>`__.
+
+	`Browse the GitHub Repository <https://github.com/domdfcoding/mh_utils>`__
 
 .. end links

doc-source/requirements.txt

@@ -8,10 +8,11 @@ repo-helper-sphinx-theme>=0.0.2
 seed-intersphinx-mapping>=0.3.1
 sphinx<3.4.0,>=3.0.3
 sphinx-copybutton>=0.2.12
+sphinx-debuginfo>=0.1.0
 sphinx-notfound-page>=0.5
 sphinx-prompt>=1.1.0
 sphinx-tabs>=1.1.13
-sphinx-toolbox>=1.8.3
+sphinx-toolbox>=2.1.0
 sphinxcontrib-httpdomain>=1.7.0
 sphinxemoji>=0.1.6
 tabulate>=0.8.9