Merge branch 'master' into pre-commit-ci-update-config

.bumpversion.cfg

@@ -12,3 +12,7 @@ tag = True
 [bumpversion:file:doc-source/index.rst]
 
 [bumpversion:file:git_toggle/__init__.py]
+search = : str = "{current_version}"
+replace = : str = "{new_version}"
+
+[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/docs_test_action.yml

@@ -2,7 +2,6 @@
 ---
 name: "Docs Check"
 on:
-  - pull_request
   - push
 
 jobs:

.github/workflows/flake8.yml

@@ -4,8 +4,6 @@ name: Flake8
 
 on:
   push:
-  pull_request:
-    branches: ["master"]
 
 jobs:
   Run:

.github/workflows/mypy.yml

@@ -4,8 +4,6 @@ name: mypy
 
 on:
   push:
-  pull_request:
-    branches: ["master"]
 
 jobs:
   Run:
@@ -14,7 +12,7 @@ jobs:
 
     strategy:
       matrix:
-        os: ['windows-2019', 'macos-latest', 'ubuntu-20.04']
+        os: ['ubuntu-20.04', 'windows-2019']
       fail-fast: false
 
     steps:

.github/workflows/python_ci.yml

@@ -4,16 +4,14 @@ name: Windows
 
 on:
   push:
-  pull_request:
-    branches: ["master"]
 
 jobs:
   tests:
     name: "windows-2019 / Python ${{ matrix.config.python-version }}"
     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 +21,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

@@ -4,16 +4,14 @@ name: Linux
 
 on:
   push:
-  pull_request:
-    branches: ["master"]
 
 jobs:
   tests:
     name: "ubuntu-20.04 / Python ${{ matrix.config.python-version }}"
     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 +21,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 🛎️
@@ -125,7 +123,7 @@ jobs:
 
       - name: Upload distribution to PyPI 🚀
         if: startsWith(github.ref, 'refs/tags/')
-        uses: pypa/gh-action-pypi-publish@master
+        uses: pypa/gh-action-pypi-publish@v1.4.2
         with:
           user: __token__
           password: ${{ secrets.PYPI_TOKEN }}

.github/workflows/python_ci_macos.yml

@@ -4,16 +4,14 @@ name: macOS
 
 on:
   push:
-  pull_request:
-    branches: ["master"]
 
 jobs:
   tests:
     name: "macos-latest / Python ${{ matrix.config.python-version }}"
     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 +21,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 🛎️

.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.1.0"
-
 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 = "git-toggle"
+project = "git-toggle".replace('_', '-')
 slug = re.sub(r'\W+', '-', project.lower())
 release = version = __version__
 copyright = "2020-2021 Dominic Davis-Foster"  # pylint: disable=redefined-builtin
@@ -34,7 +34,9 @@
 		"sphinx_toolbox",
 		"sphinx_toolbox.more_autodoc",
 		"sphinx_toolbox.more_autosummary",
+		"sphinx_toolbox.documentation_summary",
 		"sphinx_toolbox.tweaks.param_dash",
+		"sphinx_toolbox.tweaks.latex_toc",
 		"sphinx.ext.intersphinx",
 		"sphinx.ext.mathjax",
 		"sphinxcontrib.httpdomain",
@@ -45,6 +47,7 @@
 		"sphinx_copybutton",
 		"sphinxcontrib.default_values",
 		"sphinxcontrib.toctree_plus",
+		"sphinx_debuginfo",
 		"seed_intersphinx_mapping",
 		"attr_utils.autoattrs",
 		"attr_utils.annotations",
@@ -105,7 +108,7 @@
 hide_none_rtype = True
 all_typevars = True
 overloads_location = "bottom"
-
+documentation_summary = "Toggle Git remotes between https and ssh."
 
 autodoc_exclude_members = [   # Exclude "standard" methods.
 		"__dict__",