diff --git a/.github/workflows/docs_test_action.yml b/.github/workflows/docs_test_action.yml index fa1b3a4..ccbfda3 100644 --- a/.github/workflows/docs_test_action.yml +++ b/.github/workflows/docs_test_action.yml @@ -20,7 +20,7 @@ jobs: uses: "actions/checkout@v4" - name: Install and Build 🔧 - uses: sphinx-toolbox/sphinx-action@sphinx-3.3.1 + uses: sphinx-toolbox/sphinx-action@sphinx-3.3.1-py39 with: pre-build-command: python -m pip install tox diff --git a/.github/workflows/flake8.yml b/.github/workflows/flake8.yml index 0a8c0c3..5e67c5c 100644 --- a/.github/workflows/flake8.yml +++ b/.github/workflows/flake8.yml @@ -16,7 +16,7 @@ permissions: jobs: Run: name: "Flake8" - runs-on: "ubuntu-20.04" + runs-on: "ubuntu-22.04" steps: - name: Checkout 🛎️ @@ -35,7 +35,7 @@ jobs: if: steps.changes.outputs.code == 'true' uses: "actions/setup-python@v5" with: - python-version: "3.8" + python-version: "3.9" - name: Install dependencies 🔧 if: steps.changes.outputs.code == 'true' diff --git a/.github/workflows/mypy.yml b/.github/workflows/mypy.yml index 10c6f30..4c22a52 100644 --- a/.github/workflows/mypy.yml +++ b/.github/workflows/mypy.yml @@ -20,7 +20,7 @@ jobs: strategy: matrix: - os: ['ubuntu-20.04', 'windows-2019'] + os: ['ubuntu-22.04', 'windows-2022'] fail-fast: false steps: @@ -40,7 +40,7 @@ jobs: if: steps.changes.outputs.code == 'true' uses: "actions/setup-python@v5" with: - python-version: "3.8" + python-version: "3.9" - name: Install dependencies 🔧 run: | diff --git a/.github/workflows/python_ci.yml b/.github/workflows/python_ci.yml index 402027b..8bce8fa 100644 --- a/.github/workflows/python_ci.yml +++ b/.github/workflows/python_ci.yml @@ -18,8 +18,8 @@ permissions: jobs: tests: - name: "windows-2019 / Python ${{ matrix.config.python-version }}" - runs-on: "windows-2019" + name: "windows-2022 / Python ${{ matrix.config.python-version }}" + runs-on: "windows-2022" continue-on-error: ${{ matrix.config.experimental }} env: USING_COVERAGE: '3.8' diff --git a/.github/workflows/python_ci_linux.yml b/.github/workflows/python_ci_linux.yml index c020c1b..ba410b3 100644 --- a/.github/workflows/python_ci_linux.yml +++ b/.github/workflows/python_ci_linux.yml @@ -19,8 +19,8 @@ permissions: jobs: tests: - name: "ubuntu-20.04 / Python ${{ matrix.config.python-version }}" - runs-on: "ubuntu-20.04" + name: "ubuntu-22.04 / Python ${{ matrix.config.python-version }}" + runs-on: "ubuntu-22.04" continue-on-error: ${{ matrix.config.experimental }} env: USING_COVERAGE: '3.8' diff --git a/.github/workflows/python_ci_macos.yml b/.github/workflows/python_ci_macos.yml index 77f4c3b..b5f611c 100644 --- a/.github/workflows/python_ci_macos.yml +++ b/.github/workflows/python_ci_macos.yml @@ -18,8 +18,8 @@ permissions: jobs: tests: - name: "macos-13 / Python ${{ matrix.config.python-version }}" - runs-on: "macos-13" + name: "macos-${{ matrix.config.os-ver }} / Python ${{ matrix.config.python-version }}" + runs-on: "macos-${{ matrix.config.os-ver }}" continue-on-error: ${{ matrix.config.experimental }} env: USING_COVERAGE: '3.8' @@ -28,7 +28,7 @@ jobs: fail-fast: False matrix: config: - - {python-version: "3.8", testenvs: "py38,build", experimental: False} + - {python-version: "3.8", os-ver: "14", testenvs: "py38,build", experimental: False} steps: - name: Checkout 🛎️ diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 216e579..6b33129 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -8,7 +8,7 @@ ci: repos: - repo: https://github.com/repo-helper/pyproject-parser - rev: v0.11.1 + rev: v0.13.0 hooks: - id: reformat-pyproject @@ -43,7 +43,7 @@ repos: - id: bind-requirements - repo: https://github.com/python-formate/flake8-dunder-all - rev: v0.4.1 + rev: v0.5.0 hooks: - id: ensure-dunder-all files: ^contributing/.*\.py$ @@ -62,11 +62,11 @@ repos: - id: rst-inline-touching-normal - repo: https://github.com/asottile/pyupgrade - rev: v2.12.0 + rev: v3.3.0 hooks: - id: pyupgrade args: - - --py36-plus + - --py38-plus - --keep-runtime-typing - repo: https://github.com/Lucas-C/pre-commit-hooks @@ -81,7 +81,7 @@ repos: - id: snippet-fmt - repo: https://github.com/python-formate/formate - rev: v0.7.0 + rev: v0.8.0 hooks: - id: formate exclude: ^(doc-source/conf|__pkginfo__|setup)\.(_)?py$ diff --git a/.readthedocs.yml b/.readthedocs.yml index e928b70..83fc025 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -13,7 +13,7 @@ python: - requirements: requirements.txt - requirements: doc-source/requirements.txt build: - os: ubuntu-20.04 + os: ubuntu-22.04 tools: python: '3.9' jobs: diff --git a/README.rst b/README.rst index 065ba60..9d1d43f 100644 --- a/README.rst +++ b/README.rst @@ -4,8 +4,8 @@ Contributing Guide .. start short_desc -**Contributing guide for repo-helper and associated projects** +**Contributing guide for projects in the python-formate organization** .. end short_desc -View online at https://contributing.repo-helper.uk +View online at https://contributing-to-formate.readthedocs.io/ diff --git a/contributing/__init__.py b/contributing/__init__.py index 50b7374..73c78c4 100644 --- a/contributing/__init__.py +++ b/contributing/__init__.py @@ -2,7 +2,7 @@ # # __init__.py """ -Contributing guide for repo-helper and associated projects. +Contributing guide for projects in the python-formate organization. """ # # Copyright © 2020-2021 Dominic Davis-Foster diff --git a/doc-source/_templates/base.html b/doc-source/_templates/base.html index b101b24..ffdc5ad 100644 --- a/doc-source/_templates/base.html +++ b/doc-source/_templates/base.html @@ -2,4 +2,5 @@ {% extends "!base.html" %} {% block extrahead %} + {% endblock %} diff --git a/doc-source/conf.py b/doc-source/conf.py index 1b1e520..b30076c 100644 --- a/doc-source/conf.py +++ b/doc-source/conf.py @@ -102,4 +102,5 @@ def setup(app): nitpicky = True del version del release -html_title = "repo-helper Contributing Guide" +html_title = "formate Contributing Guide" +html_logo = "formate.png" diff --git a/doc-source/formate.png b/doc-source/formate.png new file mode 100644 index 0000000..02d7f8d Binary files /dev/null and b/doc-source/formate.png differ diff --git a/doc-source/getting-started.rst b/doc-source/getting-started.rst index 052b182..24d2053 100644 --- a/doc-source/getting-started.rst +++ b/doc-source/getting-started.rst @@ -49,7 +49,7 @@ With bash: .. code-block:: bash - (repo-helper) $ + (formate) $ .. _GitHub: https://github.com/ diff --git a/doc-source/requirements.txt b/doc-source/requirements.txt index 59fd245..f625fff 100644 --- a/doc-source/requirements.txt +++ b/doc-source/requirements.txt @@ -1,7 +1,9 @@ default-values>=0.6.0 +docutils<0.22 extras-require>=0.5.0 furo==2021.06.18b36 html-section>=0.3.0 +roman>=4.0 seed-intersphinx-mapping>=1.2.2 sphinx>=3.0.3 sphinx-copybutton>=0.2.12 diff --git a/pyproject.toml b/pyproject.toml index f478a43..0eaa546 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -5,7 +5,7 @@ build-backend = "whey" [project] name = "contributing" version = "2021.0.0" -description = "Contributing guide for repo-helper and associated projects" +description = "Contributing guide for projects in the python-formate organization" readme = "README.rst" keywords = [] dynamic = [ "requires-python", "classifiers", "dependencies",] @@ -18,10 +18,10 @@ name = "Dominic Davis-Foster" email = "dominic@davis-foster.co.uk" [project.urls] -Homepage = "https://github.com/repo-helper/contributing" -"Issue Tracker" = "https://github.com/repo-helper/contributing/issues" -"Source Code" = "https://github.com/repo-helper/contributing" -Documentation = "https://contributing.repo-helper.uk" +Homepage = "https://github.com/python-formate/contributing" +"Issue Tracker" = "https://github.com/python-formate/contributing/issues" +"Source Code" = "https://github.com/python-formate/contributing" +Documentation = "https://contributing-to-formate.readthedocs.io" [tool.whey] base-classifiers = [] @@ -33,7 +33,7 @@ license-key = "MIT" [tool.importcheck] [tool.sphinx-pyproject] -github_username = "repo-helper" +github_username = "python-formate" github_repository = "contributing" author = "Dominic Davis-Foster" project = "contributing" @@ -111,7 +111,7 @@ autodoc_exclude_members = [ ] [tool.mypy] -python_version = "3.8" +python_version = "3.9" namespace_packages = true check_untyped_defs = true warn_unused_ignores = true diff --git a/repo_helper.yml b/repo_helper.yml index 902445b..4e2b1b4 100644 --- a/repo_helper.yml +++ b/repo_helper.yml @@ -4,11 +4,11 @@ modname: 'contributing' copyright_years: '2020-2021' author: 'Dominic Davis-Foster' email: 'dominic@davis-foster.co.uk' -username: 'repo-helper' +username: 'python-formate' assignee: 'domdfcoding' version: '2021.0.0' license: 'MIT' -short_desc: 'Contributing guide for repo-helper and associated projects' +short_desc: 'Contributing guide for projects in the python-formate organization' use_whey: True docs_fail_on_warning: true @@ -16,7 +16,7 @@ sphinx_html_theme: furo enable_tests: false enable_conda: false on_pypi: false -docs_url: https://contributing.repo-helper.uk +docs_url: https://contributing-to-formate.readthedocs.io python_versions: - '3.8' @@ -25,7 +25,8 @@ sphinx_conf_epilogue: - nitpicky = True - del version - del release - - html_title = "repo-helper Contributing Guide" + - html_title = "formate Contributing Guide" + - html_logo = "formate.png" extra_sphinx_extensions: - html_section @@ -34,3 +35,5 @@ exclude_files: - contributing - Source_rst - license_rst + +preserve_custom_theme: true diff --git a/tox.ini b/tox.ini index a08cdc4..6f0a402 100644 --- a/tox.ini +++ b/tox.ini @@ -50,7 +50,7 @@ setenv = [testenv:docs] setenv = SHOW_TODOS = 1 passenv = SPHINX_BUILDER -basepython = python3.8 +basepython = python3.9 changedir = {toxinidir}/doc-source deps = -r{toxinidir}/doc-source/requirements.txt commands = sphinx-build -M {env:SPHINX_BUILDER:html} . ./build {posargs} @@ -74,7 +74,7 @@ commands = check-wheel-contents dist/ [testenv:lint] -basepython = python3.8 +basepython = python3.9 changedir = {toxinidir} ignore_errors = True skip_install = True @@ -94,17 +94,18 @@ deps = flake8-sphinx-links>=0.0.4 flake8-strftime>=0.1.1 flake8-typing-imports>=1.10.0 + git+https://github.com/domdfcoding/restructuredtext-lint.git@fix-deprecations 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 + git+https://github.com/domdfcoding/pydocstyle.git@stub-functions pygments>=2.7.1 importlib_metadata<4.5.0; python_version<'3.8' commands = python3 -m flake8_rst_docstrings_sphinx contributing --allow-toolbox {posargs} [testenv:perflint] -basepython = python3.8 +basepython = python3.9 changedir = {toxinidir} ignore_errors = True skip_install = True @@ -112,14 +113,14 @@ deps = perflint commands = python3 -m perflint contributing {posargs} [testenv:mypy] -basepython = python3.8 +basepython = python3.9 ignore_errors = True changedir = {toxinidir} -deps = mypy==0.971 +deps = mypy==1.17.1 commands = mypy contributing {posargs} [testenv:pyup] -basepython = python3.8 +basepython = python3.9 skip_install = True ignore_errors = True changedir = {toxinidir}