diff --git a/.github/workflows/flake8.yml b/.github/workflows/flake8.yml index 8296b42..1f5be86 100644 --- a/.github/workflows/flake8.yml +++ b/.github/workflows/flake8.yml @@ -22,7 +22,7 @@ jobs: uses: "actions/checkout@v6" - name: Check for changed files - uses: dorny/paths-filter@v2 + uses: dorny/paths-filter@v4 id: changes with: list-files: "json" diff --git a/.github/workflows/mypy.yml b/.github/workflows/mypy.yml index 4b27c5d..2b5e4f8 100644 --- a/.github/workflows/mypy.yml +++ b/.github/workflows/mypy.yml @@ -27,7 +27,7 @@ jobs: uses: "actions/checkout@v6" - name: Check for changed files - uses: dorny/paths-filter@v2 + uses: dorny/paths-filter@v4 id: changes with: list-files: "json" diff --git a/.github/workflows/python_ci.yml b/.github/workflows/python_ci.yml index 69d3252..fa2aa04 100644 --- a/.github/workflows/python_ci.yml +++ b/.github/workflows/python_ci.yml @@ -34,7 +34,7 @@ jobs: - name: Check for changed files if: startsWith(github.ref, 'refs/tags/') != true - uses: dorny/paths-filter@v2 + uses: dorny/paths-filter@v4 id: changes with: list-files: "json" diff --git a/.github/workflows/python_ci_linux.yml b/.github/workflows/python_ci_linux.yml index e9a4537..3afec52 100644 --- a/.github/workflows/python_ci_linux.yml +++ b/.github/workflows/python_ci_linux.yml @@ -35,7 +35,7 @@ jobs: - name: Check for changed files if: startsWith(github.ref, 'refs/tags/') != true - uses: dorny/paths-filter@v2 + uses: dorny/paths-filter@v4 id: changes with: list-files: "json" diff --git a/.github/workflows/python_ci_macos.yml b/.github/workflows/python_ci_macos.yml index bae9216..2f7d7a7 100644 --- a/.github/workflows/python_ci_macos.yml +++ b/.github/workflows/python_ci_macos.yml @@ -34,7 +34,7 @@ jobs: - name: Check for changed files if: startsWith(github.ref, 'refs/tags/') != true - uses: dorny/paths-filter@v2 + uses: dorny/paths-filter@v4 id: changes with: list-files: "json" diff --git a/README.rst b/README.rst index 065ba60..c8f485c 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 PyMassSpec and associated projects** .. end short_desc -View online at https://contributing.repo-helper.uk +View online at https://contributing-to-pyms.readthedocs.io diff --git a/contributing/__init__.py b/contributing/__init__.py index 50b7374..98627c8 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 PyMassSpec and associated projects. """ # # Copyright © 2020-2021 Dominic Davis-Foster diff --git a/doc-source/PyMassSpec_262.png b/doc-source/PyMassSpec_262.png new file mode 100644 index 0000000..a3cd682 Binary files /dev/null and b/doc-source/PyMassSpec_262.png differ diff --git a/doc-source/_templates/base.html b/doc-source/_templates/base.html index b101b24..69b763e 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..a9d85cb 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 = "PyMassSpec Contributing Guide" +html_logo = "PyMassSpec_262.png" diff --git a/doc-source/getting-started.rst b/doc-source/getting-started.rst index 052b182..e84c6f6 100644 --- a/doc-source/getting-started.rst +++ b/doc-source/getting-started.rst @@ -49,7 +49,7 @@ With bash: .. code-block:: bash - (repo-helper) $ + (PyMassSpec) $ .. _GitHub: https://github.com/ diff --git a/doc-source/index.rst b/doc-source/index.rst index d9a1f7d..ebbff2a 100644 --- a/doc-source/index.rst +++ b/doc-source/index.rst @@ -23,3 +23,7 @@ Contributing Guide documentation building release-process + +.. sidebar-links:: + :caption: Links + :github: diff --git a/justfile b/justfile index 9cd8b78..4307956 100644 --- a/justfile +++ b/justfile @@ -23,3 +23,8 @@ bare-ignore: lint: unused-imports incomplete-defs bare-ignore tox -n qa + +uncomm: + git status -uall --ignored + +# Custom commands can be added below this comment diff --git a/pyproject.toml b/pyproject.toml index 16db69b..ed1781e 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 PyMassSpec and associated projects" 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/PyMassSpec/contributing" +"Issue Tracker" = "https://github.com/PyMassSpec/contributing/issues" +"Source Code" = "https://github.com/PyMassSpec/contributing" +Documentation = "https://contributing-to-pyms.readthedocs.io" [tool.whey] base-classifiers = [] @@ -33,7 +33,7 @@ license-key = "MIT" [tool.importcheck] [tool.sphinx-pyproject] -github_username = "repo-helper" +github_username = "PyMassSpec" github_repository = "contributing" author = "Dominic Davis-Foster" project = "contributing" diff --git a/repo_helper.yml b/repo_helper.yml index 902445b..b6aa5ba 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: 'PyMassSpec' assignee: 'domdfcoding' version: '2021.0.0' license: 'MIT' -short_desc: 'Contributing guide for repo-helper and associated projects' +short_desc: 'Contributing guide for PyMassSpec and associated projects' use_whey: True docs_fail_on_warning: true @@ -16,7 +16,8 @@ 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-pyms.readthedocs.io +preserve_custom_theme: true python_versions: - '3.8' @@ -25,7 +26,8 @@ sphinx_conf_epilogue: - nitpicky = True - del version - del release - - html_title = "repo-helper Contributing Guide" + - html_title = "PyMassSpec Contributing Guide" + - html_logo = "PyMassSpec_262.png" extra_sphinx_extensions: - html_section