Updated config files.

Author: domdfcoding

.dependabot/config.yml

@@ -1,10 +1,9 @@
 # This file is managed by 'repo_helper'. Don't edit it directly.
 ---
-
-version: 1
 update_configs:
-  - package_manager: "python"
-    directory: "/"
-    update_schedule: "weekly"
-    default_reviewers:
-      - "domdfcoding"
+- default_reviewers:
+  - domdfcoding
+  directory: /
+  package_manager: python
+  update_schedule: weekly
+version: 1

.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-->

.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

.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 git -y && python -m pip install tox
+          pre-build-command: apt-get update && apt-get install gcc python3-dev git pandoc -y && python -m pip install tox
           docs-folder: "doc-source/"
           build-command: "tox -e docs -- "

.isort.cfg

@@ -21,6 +21,7 @@ known_third_party =
     pytest_cov
     pytest_randomly
     pytest_rerunfailures
+    pytest_timeout
     requests
 known_first_party = flake8_sphinx_links
 remove_redundant_aliases = True

.pre-commit-config.yaml

@@ -50,12 +50,12 @@ repos:
  - 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/domdfcoding/yapf-isort
-   rev: v0.3.0
+   rev: v0.3.2
    hooks:
     - id: yapf-isort
       exclude: ^(doc-source/conf|__pkginfo__|make_conda_recipe|setup)\.py$

.travis.yml

@@ -11,15 +11,17 @@ python:
   - '3.9-dev'
   - 'pypy3'
 
-arch: amd64
+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
 
@@ -31,15 +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: test
-      arch: arm64
-      python: 3.8
-
     - stage: deploy_pypi
       python: "3.6"
       script: skip

__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.

doc-source/conf.py

@@ -10,16 +10,13 @@
 sys.path.append(os.path.abspath('.'))
 sys.path.append(os.path.abspath('..'))
 
+# this package
 from __pkginfo__ import __version__
 
-# User-configurable lines
-# End of user-configurable lines
-
 github_username = "domdfcoding"
 github_repository = "flake8-sphinx-links"
 github_url = f"https://github.com/{github_username}/{github_repository}"
 
-
 rst_prolog = f""".. |pkgname| replace:: flake8_sphinx_links
 .. |pkgname2| replace:: ``flake8_sphinx_links``
 .. |browse_github| replace:: `Browse the GitHub Repository <{github_url}>`__
@@ -34,22 +31,22 @@
 package_root = "flake8_sphinx_links"
 
 extensions = [
-	'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',
-	]
+		'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))
@@ -67,9 +64,6 @@
 intersphinx_mapping = {
 		'python': ('https://docs.python.org/3/', 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),
-		"sarge": ('https://sarge.readthedocs.io/en/latest/', None),
 		}
 
 html_theme = 'domdf_sphinx_theme'
@@ -110,29 +104,33 @@
 		}
 
 add_module_names = False
-
-
+hide_none_rtype = True
+all_typevars = True
+overloads_location = "bottom"
+
+
+autodoc_exclude_members = [   # Exclude "standard" methods.
+		"__dict__",
+		"__class__",
+		"__dir__",
+		"__weakref__",
+		"__module__",
+		"__annotations__",
+		"__orig_bases__",
+		"__parameters__",
+		"__subclasshook__",
+		"__init_subclass__",
+		"__attrs_attrs__",
+		"__init__",
+		"__new__",
+		"__getnewargs__",
+		"__abstractmethods__",
+		"__hash__",
+		]
 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__",
-				"__annotations__",
-				"__orig_bases__",
-				"__parameters__",
-				"__subclasshook__",
-				"__init_subclass__",
-				"__attrs_attrs__",
-				"__init__",
-				"__new__",
-				"__getnewargs__",
-				"__abstractmethods__",
-				"__hash__",
-				]),
+		'exclude-members': ','.join(autodoc_exclude_members),
 		}

doc-source/docutils.conf

@@ -1,2 +1,2 @@
 [restructuredtext parser]
-tab_width: 4
+tab_width = 4

doc-source/requirements.txt

@@ -8,7 +8,7 @@ sphinx-copybutton>=0.2.12
 sphinx-notfound-page>=0.5
 sphinx-prompt>=1.1.0
 sphinx-tabs>=1.1.13
-sphinx-toolbox>=1.0.0
+sphinx-toolbox>=1.5.1
 sphinxcontrib-httpdomain>=1.7.0
 sphinxemoji>=0.1.6
 toctree_plus>=0.0.4

setup.py

@@ -12,13 +12,11 @@
 # this package
 from __pkginfo__ import *  # pylint: disable=wildcard-import
 
-
-
 setup(
-		description='A flake8 plugin which checks docstrings for double backticked strings that should be links to the Python documentation.',
+		description=
+		'A flake8 plugin which checks docstrings for double backticked strings that should be links to the Python documentation.',
 		extras_require=extras_require,
 		install_requires=install_requires,
 		py_modules=[],
 		version=__version__,
-
 		)

tests/requirements.txt

@@ -1,6 +1,8 @@
 coverage>=5.1
-coverage_pyver_pragma>=0.0.5
+coverage_pyver_pragma>=0.0.6
+iniconfig!=1.1.0,>=1.0.1
 pytest>=6.0.0
 pytest-cov>=2.8.1
 pytest-randomly>=3.3.1
 pytest-rerunfailures>=9.0
+pytest-timeout>=1.4.2