Updated files with 'repo_helper'.

python-coincidence · Mar 18, 2021 · 373417d · 373417d
1 parent 62b7b9d
commit 373417d
Show file tree

Hide file tree

Showing 7 changed files with 123 additions and 110 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.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.

diff --git a/.readthedocs.yml b/.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:

diff --git a/doc-source/_static/style.css b/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;
 }
diff --git a/doc-source/conf.py b/doc-source/conf.py
@@ -23,7 +23,7 @@
 """
 
 author = "Dominic Davis-Foster"
-project = "dep_checker"
+project = "dep_checker".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",

diff --git a/doc-source/index.rst b/doc-source/index.rst
@@ -10,106 +10,108 @@ dep_checker
 
 .. 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|
-	* - 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: dep_checker
-	: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: dep_checker
-	:version:
-	:alt: PyPI - Package Version
-
-.. |supported-versions| pypi-shield::
-	:project: dep_checker
-	:py-versions:
-	:alt: PyPI - Supported Python Versions
-
-.. |supported-implementations| pypi-shield::
-	:project: dep_checker
-	:implementations:
-	:alt: PyPI - Supported Implementations
-
-.. |wheel| pypi-shield::
-	:project: dep_checker
-	:wheel:
-	:alt: PyPI - Wheel
-
-.. |license| github-shield::
-	:license:
-	:alt: License
-
-.. |language| github-shield::
-	:top-language:
-	:alt: GitHub top language
-
-.. |commits-since| github-shield::
-	:commits-since: v0.5.0
-	: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: dep_checker
-	: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|
+		* - 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: dep_checker
+		: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: dep_checker
+		:version:
+		:alt: PyPI - Package Version
+
+	.. |supported-versions| pypi-shield::
+		:project: dep_checker
+		:py-versions:
+		:alt: PyPI - Supported Python Versions
+
+	.. |supported-implementations| pypi-shield::
+		:project: dep_checker
+		:implementations:
+		:alt: PyPI - Supported Implementations
+
+	.. |wheel| pypi-shield::
+		:project: dep_checker
+		:wheel:
+		:alt: PyPI - Wheel
+
+	.. |license| github-shield::
+		:license:
+		:alt: License
+
+	.. |language| github-shield::
+		:top-language:
+		:alt: GitHub top language
+
+	.. |commits-since| github-shield::
+		:commits-since: v0.5.0
+		: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: dep_checker
+		:downloads: month
+		:alt: PyPI - Downloads
+
+	.. |pre_commit_ci| pre-commit-ci-shield::
+		:alt: pre-commit.ci status
 
 .. end shields
 
@@ -148,8 +150,10 @@ Contents
 
 .. 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/dep_checker>`__
+	View the :ref:`Function Index <genindex>` or browse the `Source Code <_modules/index.html>`__.
+
+	`Browse the GitHub Repository <https://github.com/domdfcoding/dep_checker>`__
 
 .. end links
diff --git a/doc-source/requirements.txt b/doc-source/requirements.txt
@@ -10,7 +10,7 @@ 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
 toctree-plus>=0.1.0
diff --git a/tox.ini b/tox.ini
@@ -48,8 +48,7 @@ commands = sphinx-build -M html . ./build {posargs}
 skip_install = True
 changedir = {toxinidir}
 deps =
-    virtualenv
-    git+https://github.com/pypa/build
+    build[virtualenv]>=0.3.1
     check-wheel-contents>=0.1.0
     twine>=3.2.0
 commands =