Update config files.

domdfcoding · domdfcoding · commit 456fa216653b · 2020-10-12T10:00:18.000+01:00
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -9,7 +9,8 @@ assignees: domdfcoding
 <!-- Have you searched for similar issues? Before submitting this issue, please check the open issues and add a note before logging a new issue.
 
 PLEASE USE THE TEMPLATE BELOW TO PROVIDE INFORMATION ABOUT THE ISSUE.
-INSUFFICIENT INFO WILL GET THE ISSUE CLOSED. IT WILL ONLY BE REOPENED AFTER SUFFICIENT INFO IS PROVIDED-->
+THE ISSUE WILL BE CLOSED IF INSUFFICIENT INFORMATION IS PROVIDED.
+-->
 
 ## Description
 <!--Provide a brief description of the issue-->
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -7,9 +7,7 @@ assignees: domdfcoding
 ---
 
 <!-- Have you searched for similar issues? Someone may already be working on the feature you are suggesting. Before submitting this issue, please check the open issues and add a note before logging a new issue.
-
-PLEASE USE THE TEMPLATE BELOW TO PROVIDE INFORMATION ABOUT THE ISSUE.
-INSUFFICIENT INFO WILL GET THE ISSUE CLOSED. IT WILL ONLY BE REOPENED AFTER SUFFICIENT INFO IS PROVIDED-->
+-->
 
 
 ## Description
diff --git a/.github/workflows/docs_test_action.yml b/.github/workflows/docs_test_action.yml
@@ -14,6 +14,6 @@ jobs:
       - name: Install and Build 🔧
         uses: ammaraskar/sphinx-action@master
         with:
-          pre-build-command: apt-get update && apt-get install gcc python3-dev -y && python -m pip install tox
+          pre-build-command: apt-get update && apt-get install gcc python3-dev git -y && python -m pip install tox
           docs-folder: "doc-source/"
           build-command: "tox -e docs -- "
diff --git a/.github/workflows/python_ci.yml b/.github/workflows/python_ci.yml
@@ -12,12 +12,12 @@ jobs:
     name: "Python ${{ matrix.python-version }}"
     runs-on: "windows-2019"
     env:
-      USING_COVERAGE: '3.6,3.7,3.8,3.9-dev,pypy3'
+      USING_COVERAGE: '3.6,3.7,3.8,pypy3'
 
     strategy:
       fail-fast: False
       matrix:
-        python-version: ["3.6","3.7","3.8","3.9-dev","pypy3"]
+        python-version: ["3.6","3.7","3.8","pypy3"]
 
 
     steps:
diff --git a/.github/workflows/python_ci_macos.yml b/.github/workflows/python_ci_macos.yml
@@ -12,12 +12,12 @@ jobs:
     name: "Python ${{ matrix.python-version }}"
     runs-on: "macos-latest"
     env:
-      USING_COVERAGE: '3.6,3.7,3.8,3.9-dev,pypy3'
+      USING_COVERAGE: '3.6,3.7,3.8,pypy3'
 
     strategy:
       fail-fast: False
       matrix:
-        python-version: ["3.6","3.7","3.8","3.9-dev","pypy3"]
+        python-version: ["3.6","3.7","3.8","pypy3"]
 
 
     steps:
diff --git a/.isort.cfg b/.isort.cfg
@@ -17,9 +17,10 @@ known_third_party =
     flake8
     github
     pytest
-    pytest-cov
-    pytest-randomly
-    pytest-rerunfailures
+    pytest_cov
+    pytest_randomly
+    pytest_rerunfailures
+    pytest_timeout
     requests
 known_first_party = coverage_pyver_pragma
 remove_redundant_aliases = True
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -22,48 +22,40 @@ repos:
     - id: mixed-line-ending
 
  - repo: https://github.com/domdfcoding/pre-commit-hooks
-   rev: v0.0.2
+   rev: v0.0.4
    hooks:
     - id: requirements-txt-sorter
+      args: [--allow-git]
     - id: check-docstring-first
+      exclude: ^(doc-source/conf|__pkginfo__|make_conda_recipe|setup|tests/.*)\.py$
+    - id: bind-requirements
+
+ - repo: https://github.com/domdfcoding/flake8-dunder-all
+   rev: v0.0.4
+   hooks:
+    - id: ensure-dunder-all
+      files: ^coverage_pyver_pragma/.*\.py$
 
  - repo: https://github.com/pre-commit/pygrep-hooks
    rev: v1.5.1
    hooks:
     - id: python-no-eval
-    - id: python-use-type-annotations
 
  - repo: https://github.com/asottile/pyupgrade
    rev: v1.5.1
    hooks:
     - id: pyupgrade
       args: [--py36-plus]
 
- - repo: https://github.com/timothycrosley/isort
-   rev: 5.1.4
-   hooks:
-    - id: isort
-      exclude: ^(doc-source/conf|__pkginfo__|make_conda_recipe|setup)\.py$
-
- - repo: https://github.com/pre-commit/mirrors-yapf
-   rev: v0.30.0
-   hooks:
-    - id: yapf
-      exclude: ^(doc-source/conf|__pkginfo__|make_conda_recipe|setup)\.py$
-      args: ["--in-place"]
-
  - repo: https://github.com/Lucas-C/pre-commit-hooks
    rev: v1.1.7
    hooks:
-    - id: forbid-crlf
     - id: remove-crlf
+    - id: forbid-crlf
 
-# - repo: https://github.com/shellcheck-py/shellcheck-py
-#   rev: v0.7.1.1
-#   hooks:
-#    - id: shellcheck
 
-# - repo: https://github.com/adrienverge/yamllint
-#   rev: v1.23.0
-#   hooks:
-#    - id: yamllint
+ - repo: https://github.com/domdfcoding/yapf-isort
+   rev: v0.3.0
+   hooks:
+    - id: yapf-isort
+      exclude: ^(doc-source/conf|__pkginfo__|make_conda_recipe|setup)\.py$
diff --git a/.travis.yml b/.travis.yml
@@ -2,7 +2,7 @@
 ---
 
 language: python
-dist: xenial
+dist: focal
 cache: pip
 python:
   - '3.6'
@@ -11,14 +11,17 @@ python:
   - '3.9-dev'
   - 'pypy3'
 
+arch:
+  - amd64
+  - arm64
 install:
 
   - pip install --upgrade pip
   - pip install tox tox-travis
   - pip install coveralls coverage_pyver_pragma
 
 script:
-  - tox
+  - tox -vv
 after_success:
   - coveralls
 
@@ -30,7 +33,24 @@ stages:
 
 
 jobs:
+  allow_failures:
+    - arch: arm64
+
+  exclude:
+    - python: '3.7'
+      arch: arm64
+    - python: '3.8'
+      arch: arm64
+    - python: '3.9-dev'
+      arch: arm64
+    - python: 'pypy3'
+      arch: arm64
+
   include:
+    - stage: test
+      dist: bionic
+      python: 3.8
+
     - stage: deploy_pypi
       python: "3.6"
       script: skip
@@ -56,7 +76,5 @@ jobs:
         - chmod +x .ci/travis_deploy_conda.sh
       script: skip
       deploy:
-        on:
-          repo: domdfcoding/coverage_pyver_pragma
         provider: script
         script: .ci/travis_deploy_conda.sh || return 1;
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -1,9 +1,9 @@
-.. This file based on https://github.com/PyGithub/PyGithub/blob/master/CONTRIBUTING.md
-
 ==============
 Contributing
 ==============
 
+.. This file based on https://github.com/PyGithub/PyGithub/blob/master/CONTRIBUTING.md
+
 ``coverage_pyver_pragma`` uses `tox <https://tox.readthedocs.io>`_ to automate testing and packaging, and `pre-commit <https://pre-commit.com>`_ to maintain code quality.
 
 Install ``pre-commit`` with ``pip`` and install the git hook:
diff --git a/README.rst b/README.rst
@@ -30,7 +30,7 @@ coverage_pyver_pragma
 
 .. |docs| image:: https://img.shields.io/readthedocs/coverage_pyver_pragma/latest?logo=read-the-docs
 	:target: https://coverage_pyver_pragma.readthedocs.io/en/latest/?badge=latest
-	:alt: Documentation Status
+	:alt: Documentation Build Status
 
 .. |docs_check| image:: https://github.com/domdfcoding/coverage_pyver_pragma/workflows/Docs%20Check/badge.svg
 	:target: https://github.com/domdfcoding/coverage_pyver_pragma/actions?query=workflow%3A%22Docs+Check%22
diff --git a/__pkginfo__.py b/__pkginfo__.py
@@ -1,5 +1,5 @@
 #  This file is managed by 'repo_helper'. Don't edit it directly.
-#  Copyright (C) 2020 Dominic Davis-Foster <dominic@davis-foster.co.uk>
+#  Copyright © 2020 Dominic Davis-Foster <dominic@davis-foster.co.uk>
 #
 #  This file is distributed under the same license terms as the program it came with.
 #  There will probably be a file called LICEN[S/C]E in the same directory as this file.
diff --git a/doc-source/conf.py b/doc-source/conf.py
@@ -7,9 +7,6 @@
 import re
 import sys
 
-# 3rd party
-from sphinx.locale import _
-
 sys.path.append(os.path.abspath('.'))
 sys.path.append(os.path.abspath('..'))
 
@@ -18,7 +15,10 @@
 # User-configurable lines
 # End of user-configurable lines
 
-github_url = "https://github.com/domdfcoding/coverage_pyver_pragma"
+github_username = "domdfcoding"
+github_repository = "coverage_pyver_pragma"
+github_url = f"https://github.com/{github_username}/{github_repository}"
+
 
 rst_prolog = f""".. |pkgname| replace:: coverage_pyver_pragma
 .. |pkgname2| replace:: ``coverage_pyver_pragma``
@@ -34,25 +34,22 @@
 package_root = "coverage_pyver_pragma"
 
 extensions = [
-		'sphinx.ext.intersphinx',
-		'sphinx.ext.autodoc',
-		'sphinx.ext.mathjax',
-		'sphinx.ext.viewcode',
-		'sphinxcontrib.httpdomain',
-		"sphinxcontrib.extras_require",
-		"sphinx.ext.todo",
-		"sphinxemoji.sphinxemoji",
-		"notfound.extension",
-		"sphinx_tabs.tabs",
-		"sphinx-prompt",
-		"sphinx_autodoc_typehints",
-		"sphinx.ext.autosummary",
-		"autodocsumm",
-		"sphinx_copybutton",
-		"sphinxcontrib.default_values",
-		"sphinxcontrib.toctree_plus",
-		# "sphinx_gitstamp",
-		]
+	'sphinx_toolbox',
+	'sphinx_toolbox.more_autodoc',
+	'sphinx_toolbox.more_autosummary',
+	'sphinx_toolbox.tweaks.param_dash',
+	'sphinx.ext.intersphinx',
+	'sphinx.ext.mathjax',
+	'sphinxcontrib.httpdomain',
+	'sphinxcontrib.extras_require',
+	'sphinx.ext.todo',
+	'sphinxemoji.sphinxemoji',
+	'notfound.extension',
+	'sphinx_copybutton',
+	'sphinxcontrib.default_values',
+	'sphinxcontrib.toctree_plus',
+	'seed_intersphinx_mapping',
+	]
 
 sphinxemoji_style = 'twemoji'
 todo_include_todos = bool(os.environ.get("SHOW_TODOS", 0))
@@ -68,18 +65,11 @@
 pygments_style = 'default'
 
 intersphinx_mapping = {
-		'rtd': ('https://docs.readthedocs.io/en/latest/', None),
-		'sphinx': ('https://www.sphinx-doc.org/en/stable/', None),
 		'python': ('https://docs.python.org/3/', None),
-		"NumPy": ('https://numpy.org/doc/stable/', None),
-		"SciPy": ('https://docs.scipy.org/doc/scipy/reference', None),
-		"Pandas": ('https://pandas.pydata.org/docs/', None),
-		"matplotlib": ('https://matplotlib.org', None),
+		'sphinx': ('https://www.sphinx-doc.org/en/stable/', None),
+		'rtd': ('https://docs.readthedocs.io/en/latest/', None),
 		"h5py": ('https://docs.h5py.org/en/latest/', None),
-		"Sphinx": ('https://www.sphinx-doc.org/en/master/', None),
-		"Django": ('https://docs.djangoproject.com/en/dev/', 'https://docs.djangoproject.com/en/dev/_objects/'),
 		"sarge": ('https://sarge.readthedocs.io/en/latest/', None),
-		"attrs": ('https://www.attrs.org/en/stable/', None),
 		}
 
 html_theme = 'domdf_sphinx_theme'
@@ -103,13 +93,33 @@
 man_pages = [('index', slug, project, [author], 1)]
 texinfo_documents = [('index', slug, project, author, slug, project, 'Miscellaneous')]
 
+toctree_plus_types = {
+		"class",
+		"function",
+		"method",
+		"data",
+		"enum",
+		"flag",
+		"confval",
+		"directive",
+		"role",
+		"confval",
+		"protocol",
+		"typeddict",
+		"namedtuple",
+		}
+
+add_module_names = False
+
 
 autodoc_default_options = {
 		'members': None,  # Include all members (methods).
 		'special-members': None,
 		"autosummary": None,
+		"show-inheritance": None,
 		'exclude-members': ','.join([   # Exclude "standard" methods.
 				"__dict__",
+				"__class__",
 				"__dir__",
 				"__weakref__",
 				"__module__",
@@ -118,33 +128,11 @@
 				"__parameters__",
 				"__subclasshook__",
 				"__init_subclass__",
-				])
+				"__attrs_attrs__",
+				"__init__",
+				"__new__",
+				"__getnewargs__",
+				"__abstractmethods__",
+				"__hash__",
+				]),
 		}
-
-
-# Extensions to theme docs
-def setup(app):
-	from sphinx.domains.python import PyField
-	from sphinx.util.docfields import Field
-
-	app.add_object_type(
-			'confval',
-			'confval',
-			objname='configuration value',
-			indextemplate='pair: %s; configuration value',
-			doc_field_types=[
-					PyField(
-							'type',
-							label=_('Type'),
-							has_arg=False,
-							names=('type', ),
-							bodyrolename='class',
-							),
-					Field(
-							'default',
-							label=_('Default'),
-							has_arg=False,
-							names=('default', ),
-							),
-					]
-			)
diff --git a/doc-source/contributing.rst b/doc-source/contributing.rst
@@ -1,8 +1,7 @@
-.. This file based on https://github.com/PyGithub/PyGithub/blob/master/CONTRIBUTING.md
+Overview
+---------
 
-==============
-Contributing
-==============
+.. This file based on https://github.com/PyGithub/PyGithub/blob/master/CONTRIBUTING.md
 
 ``coverage_pyver_pragma`` uses `tox <https://tox.readthedocs.io>`_ to automate testing and packaging, and `pre-commit <https://pre-commit.com>`_ to maintain code quality.
 
diff --git a/doc-source/index.rst b/doc-source/index.rst
diff --git a/doc-source/requirements.txt b/doc-source/requirements.txt
diff --git a/setup.cfg b/setup.cfg
diff --git a/setup.py b/setup.py
diff --git a/tests/requirements.txt b/tests/requirements.txt
diff --git a/tox.ini b/tox.ini
