Updated files with 'repo_helper'. (#14)

Co-authored-by: repo-helper[bot] <74742576+repo-helper[bot]@users.noreply.github.com>

Author: repo-helper[bot]

.bumpversion.cfg

@@ -17,3 +17,7 @@ replace = : str = "{new_version}"
 [bumpversion:file:doc-source/index.rst]
 
 [bumpversion:file:pyproject.toml]
+
+[bumpversion:file:setup.cfg]
+search = name = {current_version}
+replace = name = {new_version}

.pre-commit-config.yaml

@@ -31,7 +31,7 @@ repos:
       args:
        - --allow-git
     - id: check-docstring-first
-      exclude: ^(doc-source/conf|__pkginfo__|make_conda_recipe|setup|tests/.*)\.py$
+      exclude: ^(doc-source/conf|__pkginfo__|setup|tests/.*)\.py$
     - id: bind-requirements
 
  - repo: https://github.com/domdfcoding/flake8-dunder-all
@@ -71,7 +71,7 @@ repos:
    rev: v0.4.3
    hooks:
     - id: formate
-      exclude: ^(doc-source/conf|__pkginfo__|make_conda_recipe|setup)\.(_)?py$
+      exclude: ^(doc-source/conf|__pkginfo__|setup)\.(_)?py$
 
  - repo: https://github.com/domdfcoding/dep_checker
    rev: v0.6.1

README.rst

@@ -24,7 +24,7 @@ tox-recreate-hook
 	* - Activity
 	  - |commits-latest| |commits-since| |maintained| |pypi-downloads|
 	* - QA
-	  - |codefactor| |actions_flake8| |actions_mypy| |pre_commit_ci|
+	  - |codefactor| |actions_flake8| |actions_mypy|
 	* - Other
 	  - |license| |language| |requires|
 
@@ -106,10 +106,6 @@ tox-recreate-hook
 	:target: https://pypi.org/project/tox-recreate-hook/
 	:alt: PyPI - Downloads
 
-.. |pre_commit_ci| image:: https://results.pre-commit.ci/badge/github/python-coincidence/tox-recreate-hook/master.svg
-	:target: https://results.pre-commit.ci/latest/github/python-coincidence/tox-recreate-hook/master
-	:alt: pre-commit.ci status
-
 .. end shields
 
 Installation

__pkginfo__.py

@@ -11,22 +11,10 @@
 # This script based on https://github.com/rocky/python-uncompyle6/blob/master/__pkginfo__.py
 #
 
-# stdlib
-import pathlib
-
 __all__ = [
-		"__copyright__",
 		"__version__",
-		"repo_root",
-		"install_requires",
 		"extras_require",
 		]
 
-__copyright__ = """
-2021 Dominic Davis-Foster <[email protected]>
-"""
-
 __version__ = "0.1.0"
-repo_root = pathlib.Path(__file__).parent
-install_requires = (repo_root / "requirements.txt").read_text(encoding="utf-8").split('\n')
 extras_require = {}

doc-source/conf.py

@@ -5,31 +5,19 @@
 # stdlib
 import os
 import re
-import sys
 
-sys.path.append(os.path.abspath('.'))
-sys.path.append(os.path.abspath(".."))
+# 3rd party
+from sphinx_pyproject import SphinxConfig
 
-# this package
-from __pkginfo__ import __version__
+config = SphinxConfig()
 
 github_username = "python-coincidence"
 github_repository = "tox-recreate-hook"
-github_url = f"https://github.com/{github_username}/{github_repository}"
-
-rst_prolog = f""".. |pkgname| replace:: tox-recreate-hook
-.. |pkgname2| replace:: ``tox-recreate-hook``
-.. |browse_github| replace:: `Browse the GitHub Repository <{github_url}>`__
-"""
-
 author = "Dominic Davis-Foster"
-project = "tox-recreate-hook".replace('_', '-')
-slug = re.sub(r'\W+', '-', project.lower())
-release = version = __version__
-copyright = "2021 Dominic Davis-Foster"  # pylint: disable=redefined-builtin
+project = "tox-recreate-hook"
+copyright = "2021 Dominic Davis-Foster"
 language = "en"
 package_root = "tox_recreate_hook"
-
 extensions = [
 		"sphinx_toolbox",
 		"sphinx_toolbox.more_autodoc",
@@ -50,71 +38,38 @@
 		"sphinx_debuginfo",
 		"seed_intersphinx_mapping",
 		]
-
 sphinxemoji_style = "twemoji"
-todo_include_todos = bool(os.environ.get("SHOW_TODOS", 0))
 gitstamp_fmt = "%d %b %Y"
-
 templates_path = ["_templates"]
 html_static_path = ["_static"]
 source_suffix = ".rst"
 master_doc = "index"
 suppress_warnings = ["image.nonlocal_uri"]
 pygments_style = "default"
-
-intersphinx_mapping = {
-		"python": ("https://docs.python.org/3/", None),
-		"sphinx": ("https://www.sphinx-doc.org/en/stable/", None),
-		"tox": ("https://tox.readthedocs.io/en/latest/", None),
-		}
-
 html_theme = "furo"
-html_theme_options = {
-		"light_css_variables": {
-				"toc-title-font-size": "12pt",
-				"toc-font-size": "12pt",
-				"admonition-font-size": "12pt",
-				},
-		"dark_css_variables": {
-				"toc-title-font-size": "12pt",
-				"toc-font-size": "12pt",
-				"admonition-font-size": "12pt",
-				},
-		}
 html_theme_path = ["../.."]
-html_show_sourcelink = True  # True will show link to source
-
-html_context = {}
-htmlhelp_basename = slug
-
-latex_documents = [("index", f'{slug}.tex', project, author, "manual")]
-man_pages = [("index", slug, project, [author], 1)]
-texinfo_documents = [("index", slug, project, author, slug, project, "Miscellaneous")]
-
-toctree_plus_types = {
+html_show_sourcelink = True
+toctree_plus_types = [
 		"class",
-		"function",
-		"method",
+		"confval",
 		"data",
+		"directive",
 		"enum",
+		"exception",
 		"flag",
-		"confval",
-		"directive",
-		"role",
-		"confval",
+		"function",
+		"method",
+		"namedtuple",
 		"protocol",
+		"role",
 		"typeddict",
-		"namedtuple",
-		"exception",
-		}
-
+		]
 add_module_names = False
 hide_none_rtype = True
 all_typevars = True
 overloads_location = "bottom"
 documentation_summary = "(experimental) Allows hooks to be defined which are called when recreating a tox testenv."
-
-autodoc_exclude_members = [   # Exclude "standard" methods.
+autodoc_exclude_members = [
 		"__dict__",
 		"__class__",
 		"__dir__",
@@ -132,6 +87,47 @@
 		"__abstractmethods__",
 		"__hash__",
 		]
+
+github_url = f"https://github.com/{github_username}/{github_repository}"
+
+rst_prolog = f""".. |pkgname| replace:: tox-recreate-hook
+.. |pkgname2| replace:: ``tox-recreate-hook``
+.. |browse_github| replace:: `Browse the GitHub Repository <{github_url}>`__
+"""
+
+slug = re.sub(r'\W+', '-', project.lower())
+release = version = config.version
+
+todo_include_todos = bool(os.environ.get("SHOW_TODOS", 0))
+
+intersphinx_mapping = {
+		"python": ("https://docs.python.org/3/", None),
+		"sphinx": ("https://www.sphinx-doc.org/en/stable/", None),
+		"tox": ("https://tox.readthedocs.io/en/latest/", None),
+		}
+
+html_theme_options = {
+		"light_css_variables": {
+				"toc-title-font-size": "12pt",
+				"toc-font-size": "12pt",
+				"admonition-font-size": "12pt",
+				},
+		"dark_css_variables": {
+				"toc-title-font-size": "12pt",
+				"toc-font-size": "12pt",
+				"admonition-font-size": "12pt",
+				},
+		}
+
+html_context = {}
+htmlhelp_basename = slug
+
+latex_documents = [("index", f'{slug}.tex', project, author, "manual")]
+man_pages = [("index", slug, project, [author], 1)]
+texinfo_documents = [("index", slug, project, author, slug, project, "Miscellaneous")]
+
+toctree_plus_types = set(toctree_plus_types)
+
 autodoc_default_options = {
 		"members": None,  # Include all members (methods).
 		"special-members": None,

doc-source/index.rst

@@ -25,7 +25,7 @@ tox-recreate-hook
 		* - Activity
 		  - |commits-latest| |commits-since| |maintained| |pypi-downloads|
 		* - QA
-		  - |codefactor| |actions_flake8| |actions_mypy| |pre_commit_ci|
+		  - |codefactor| |actions_flake8| |actions_mypy|
 		* - Other
 		  - |license| |language| |requires|
 
@@ -110,9 +110,6 @@ tox-recreate-hook
 		:downloads: month
 		:alt: PyPI - Downloads
 
-	.. |pre_commit_ci| pre-commit-ci-shield::
-		:alt: pre-commit.ci status
-
 .. end shields
 
 Installation

doc-source/requirements.txt

@@ -8,6 +8,7 @@ sphinx-copybutton>=0.2.12
 sphinx-debuginfo>=0.1.0
 sphinx-notfound-page>=0.5
 sphinx-prompt>=1.1.0
+sphinx-pyproject>=0.1.0
 sphinx-tabs>=1.1.13
 sphinx-toolbox>=2.2.0
 sphinxcontrib-httpdomain>=1.7.0