Updated files with 'repo_helper'.

sphinx-toolbox · Jul 21, 2022 · fef2ad8 · fef2ad8
1 parent aa8f260
commit fef2ad8
Show file tree

Hide file tree

Showing 9 changed files with 54 additions and 20 deletions.
diff --git a/.github/stale.yml b/.github/stale.yml
@@ -7,7 +7,7 @@ daysUntilStale: 180
 
 # Number of days of inactivity before an Issue or Pull Request with the stale label is closed.
 # Set to false to disable. If disabled, issues still need to be closed manually, but will remain marked as stale.
-daysUntilClose: 180
+daysUntilClose: false
 
 # Only issues or pull requests with all of these labels are check if stale. Defaults to `[]` (disabled)
 onlyLabels: []
@@ -31,10 +31,10 @@ exemptAssignees: false
 staleLabel: stale
 
 # Comment to post when marking as stale. Set to `false` to disable
-markComment: >
-  This issue has been automatically marked as stale because it has not had
-  recent activity. It will be closed if no further activity occurs. Thank you
-  for your contributions.
+markComment: false
+#  This issue has been automatically marked as stale because it has not had
+#  recent activity. It will be closed if no further activity occurs. Thank you
+#  for your contributions.
 
 # Comment to post when removing the stale label.
 # unmarkComment: >

diff --git a/.github/workflows/python_ci.yml b/.github/workflows/python_ci.yml
@@ -22,7 +22,7 @@ jobs:
     runs-on: "windows-2019"
     continue-on-error: ${{ matrix.config.experimental }}
     env:
-      USING_COVERAGE: '3.6,3.7,3.8,3.9,3.10,3.11.0-alpha.6,pypy-3.6,pypy-3.7,pypy-3.8'
+      USING_COVERAGE: '3.6,3.7,3.8,3.9,3.10,3.11.0-beta.3,pypy-3.6,pypy-3.7,pypy-3.8'
 
     strategy:
       fail-fast: False
@@ -33,7 +33,7 @@ jobs:
           - {python-version: "3.8", testenvs: "py38,build", experimental: False}
           - {python-version: "3.9", testenvs: "py39,build", experimental: False}
           - {python-version: "3.10", testenvs: "py310,build", experimental: False}
-          - {python-version: "3.11.0-alpha.6", testenvs: "py311-dev,build", experimental: True}
+          - {python-version: "3.11.0-beta.3", testenvs: "py311-dev,build", experimental: True}
           - {python-version: "pypy-3.6", testenvs: "pypy36,build", experimental: False}
           - {python-version: "pypy-3.7", testenvs: "pypy37,build", experimental: True}
           - {python-version: "pypy-3.8", testenvs: "pypy38,build", experimental: True}

diff --git a/.github/workflows/python_ci_linux.yml b/.github/workflows/python_ci_linux.yml
@@ -23,7 +23,7 @@ jobs:
     runs-on: "ubuntu-20.04"
     continue-on-error: ${{ matrix.config.experimental }}
     env:
-      USING_COVERAGE: '3.6,3.7,3.8,3.9,3.10,3.11.0-alpha.6,pypy-3.6,pypy-3.7,pypy-3.8'
+      USING_COVERAGE: '3.6,3.7,3.8,3.9,3.10,3.11.0-beta.3,pypy-3.6,pypy-3.7,pypy-3.8'
 
     strategy:
       fail-fast: False
@@ -34,7 +34,7 @@ jobs:
           - {python-version: "3.8", testenvs: "py38,build", experimental: False}
           - {python-version: "3.9", testenvs: "py39,build", experimental: False}
           - {python-version: "3.10", testenvs: "py310,build", experimental: False}
-          - {python-version: "3.11.0-alpha.6", testenvs: "py311-dev,build", experimental: True}
+          - {python-version: "3.11.0-beta.3", testenvs: "py311-dev,build", experimental: True}
           - {python-version: "pypy-3.6", testenvs: "pypy36,build", experimental: False}
           - {python-version: "pypy-3.7", testenvs: "pypy37,build", experimental: True}
           - {python-version: "pypy-3.8", testenvs: "pypy38,build", experimental: True}

diff --git a/.github/workflows/python_ci_macos.yml b/.github/workflows/python_ci_macos.yml
@@ -22,7 +22,7 @@ jobs:
     runs-on: "macos-latest"
     continue-on-error: ${{ matrix.config.experimental }}
     env:
-      USING_COVERAGE: '3.6,3.7,3.8,3.9,3.10,3.11.0-alpha.6,pypy-3.7,pypy-3.8'
+      USING_COVERAGE: '3.6,3.7,3.8,3.9,3.10,3.11.0-beta.3,pypy-3.7,pypy-3.8'
 
     strategy:
       fail-fast: False
@@ -33,7 +33,7 @@ jobs:
           - {python-version: "3.8", testenvs: "py38,build", experimental: False}
           - {python-version: "3.9", testenvs: "py39,build", experimental: False}
           - {python-version: "3.10", testenvs: "py310,build", experimental: False}
-          - {python-version: "3.11.0-alpha.6", testenvs: "py311-dev,build", experimental: True}
+          - {python-version: "3.11.0-beta.3", testenvs: "py311-dev,build", experimental: True}
           - {python-version: "pypy-3.7", testenvs: "pypy37,build", experimental: True}
           - {python-version: "pypy-3.8", testenvs: "pypy38,build", experimental: True}
 

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -5,7 +5,7 @@ exclude: ^$
 
 repos:
  - repo: https://github.com/repo-helper/pyproject-parser
-   rev: v0.4.2
+   rev: v0.7.0
    hooks:
     - id: reformat-pyproject
 
@@ -30,7 +30,7 @@ repos:
     - id: end-of-file-fixer
 
  - repo: https://github.com/domdfcoding/pre-commit-hooks
-   rev: v0.3.0
+   rev: v0.4.0
    hooks:
     - id: requirements-txt-sorter
       args:
@@ -40,7 +40,7 @@ repos:
     - id: bind-requirements
 
  - repo: https://github.com/domdfcoding/flake8-dunder-all
-   rev: v0.1.8
+   rev: v0.2.1
    hooks:
     - id: ensure-dunder-all
       files: ^seed_intersphinx_mapping/.*\.py$
@@ -67,7 +67,7 @@ repos:
        - --keep-runtime-typing
 
  - repo: https://github.com/Lucas-C/pre-commit-hooks
-   rev: v1.1.11
+   rev: v1.2.0
    hooks:
     - id: remove-crlf
     - id: forbid-crlf
@@ -78,13 +78,13 @@ repos:
     - id: snippet-fmt
 
  - repo: https://github.com/python-formate/formate
-   rev: v0.4.9
+   rev: v0.4.10
    hooks:
     - id: formate
       exclude: ^(doc-source/conf|__pkginfo__|setup)\.(_)?py$
 
  - repo: https://github.com/domdfcoding/dep_checker
-   rev: v0.6.2
+   rev: v0.7.0
    hooks:
     - id: dep_checker
       args:

diff --git a/doc-source/conf.py b/doc-source/conf.py
@@ -27,7 +27,8 @@
 slug = re.sub(r'\W+', '-', project.lower())
 release = version = config.version
 
-todo_include_todos = bool(os.environ.get("SHOW_TODOS", 0))
+sphinx_builder = os.environ.get("SPHINX_BUILDER", "html").lower()
+todo_include_todos = int(os.environ.get("SHOW_TODOS", 0)) and sphinx_builder != "latex"
 
 intersphinx_mapping = {
 		"python": ("https://docs.python.org/3/", None),

diff --git a/justfile b/justfile
@@ -0,0 +1,22 @@
+default: lint
+
+pdf-docs: latex-docs
+	make -C doc-source/build/latex/
+
+latex-docs:
+	SPHINX_BUILDER=latex tox -e docs
+
+unused-imports:
+	tox -e lint -- --select F401
+
+incomplete-defs:
+	tox -e lint -- --select MAN
+
+vdiff:
+	git diff $(repo-helper show version -q)..HEAD
+
+bare-ignore:
+	greppy '# type:? *ignore(?!\[|\w)' -s
+
+lint: unused-imports incomplete-defs bare-ignore
+	tox -n qa
diff --git a/pyproject.toml b/pyproject.toml
@@ -58,6 +58,7 @@ extensions = [
     "sphinx_toolbox.more_autosummary",
     "sphinx_toolbox.documentation_summary",
     "sphinx_toolbox.tweaks.param_dash",
+    "sphinxcontrib.toctree_plus",
     "sphinx_toolbox.tweaks.latex_layout",
     "sphinx_toolbox.tweaks.latex_toc",
     "sphinx.ext.intersphinx",
@@ -68,7 +69,6 @@ extensions = [
     "notfound.extension",
     "sphinx_copybutton",
     "sphinxcontrib.default_values",
-    "sphinxcontrib.toctree_plus",
     "sphinx_debuginfo",
     "sphinx_licenseinfo",
     "seed_intersphinx_mapping",

diff --git a/tox.ini b/tox.ini
@@ -5,6 +5,7 @@
 #     * testenv:docs
 #     * testenv:build
 #     * testenv:lint
+#     * testenv:perflint
 #     * testenv:mypy
 #     * testenv:pyup
 #     * testenv:coverage
@@ -40,6 +41,7 @@ cov = py36, coverage
 
 [testenv:docs]
 setenv = SHOW_TODOS = 1
+passenv = SPHINX_BUILDER
 basepython = python3.8
 changedir = {toxinidir}/doc-source
 deps = -r{toxinidir}/doc-source/requirements.txt
@@ -70,7 +72,7 @@ deps =
     flake8-dunder-all>=0.1.1
     flake8-encodings>=0.1.0
     flake8-github-actions>=0.1.0
-    flake8-noqa>=1.1.0
+    flake8-noqa>=1.1.0,<=1.2.2
     flake8-pyi>=20.10.0
     flake8-pytest-style>=1.3.0
     flake8-quotes>=3.3.0
@@ -81,11 +83,20 @@ deps =
     git+https://github.com/domdfcoding/flake8-rst-docstrings-sphinx.git
     git+https://github.com/domdfcoding/flake8-rst-docstrings.git
     git+https://github.com/python-formate/flake8-unused-arguments.git@magic-methods
+    git+https://github.com/python-formate/flake8-missing-annotations.git
     pydocstyle>=6.0.0
     pygments>=2.7.1
     importlib_metadata<4.5.0; python_version<'3.8'
 commands = python3 -m flake8_rst_docstrings_sphinx seed_intersphinx_mapping tests --allow-toolbox {posargs}
 
+[testenv:perflint]
+basepython = python3.6
+changedir = {toxinidir}
+ignore_errors = True
+skip_install = True
+deps = perflint
+commands = python3 -m perflint seed_intersphinx_mapping {posargs}
+
 [testenv:mypy]
 basepython = python3.6
 ignore_errors = True