diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index adc4683..a820125 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -32,7 +32,7 @@ repos: - id: end-of-file-fixer - repo: https://github.com/domdfcoding/pre-commit-hooks - rev: v0.4.0 + rev: v0.5.0 hooks: - id: requirements-txt-sorter args: @@ -80,7 +80,7 @@ repos: - id: snippet-fmt - repo: https://github.com/python-formate/formate - rev: v0.9.0 + rev: v1.1.2 hooks: - id: formate exclude: ^(doc-source/conf|__pkginfo__|setup)\.(_)?py$ diff --git a/README.rst b/README.rst index 065ba60..2ece055 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-coincidence organization.** .. end short_desc -View online at https://contributing.repo-helper.uk +View online at https://contributing-to-coincidence.readthedocs.io/ diff --git a/contributing/__init__.py b/contributing/__init__.py index 50b7374..d99339e 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-coincidence organization. """ # # Copyright © 2020-2021 Dominic Davis-Foster diff --git a/doc-source/_templates/base.html b/doc-source/_templates/base.html index b101b24..8dd237a 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/coincidence.png b/doc-source/coincidence.png new file mode 100644 index 0000000..41a2883 Binary files /dev/null and b/doc-source/coincidence.png differ diff --git a/doc-source/conf.py b/doc-source/conf.py index 1b1e520..9e7d141 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 = "python-coincidence Contributing Guide" +html_logo = "coincidence.png" diff --git a/doc-source/getting-started.rst b/doc-source/getting-started.rst index 052b182..54f31b8 100644 --- a/doc-source/getting-started.rst +++ b/doc-source/getting-started.rst @@ -49,7 +49,7 @@ With bash: .. code-block:: bash - (repo-helper) $ + (coincidence) $ .. _GitHub: https://github.com/ diff --git a/formate.toml b/formate.toml index d9387a5..f250168 100644 --- a/formate.toml +++ b/formate.toml @@ -5,6 +5,7 @@ reformat-generics = 40 noqa-reformat = 60 ellipsis-reformat = 70 squish_stubs = 80 +newline_after_equals = 90 [hooks.yapf] priority = 30 diff --git a/pyproject.toml b/pyproject.toml index 16db69b..66ff52f 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-coincidence 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-coincidence/contributing" +"Issue Tracker" = "https://github.com/python-coincidence/contributing/issues" +"Source Code" = "https://github.com/python-coincidence/contributing" +Documentation = "https://contributing-to-coincidence.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-coincidence" github_repository = "contributing" author = "Dominic Davis-Foster" project = "contributing" diff --git a/repo_helper.yml b/repo_helper.yml index 902445b..4db585f 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-coincidence' 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-coincidence 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-coincidence.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 = "python-coincidence Contributing Guide" + - html_logo = "coincidence.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 2cc0fbc..7be7ac9 100644 --- a/tox.ini +++ b/tox.ini @@ -104,7 +104,6 @@ deps = git+https://github.com/python-formate/flake8-missing-annotations.git 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]