From 46c0abbc0686d67c37f0bb20a3d9a0303ae36240 Mon Sep 17 00:00:00 2001 From: Kyle Oliver Date: Sat, 26 Jul 2025 12:27:57 -0400 Subject: [PATCH 1/2] chore: update demo to the latest cookiecutter-robust-python --- .cookiecutter.json | 2 +- .cruft.json | 4 ++-- .../{docs-build.yml => build-docs.yml} | 18 ++++++++---------- .readthedocs.yml | 8 ++++++++ noxfile.py | 2 +- scripts/setup-remote.py | 4 ++++ 6 files changed, 24 insertions(+), 14 deletions(-) rename .github/workflows/{docs-build.yml => build-docs.yml} (66%) create mode 100644 .readthedocs.yml diff --git a/.cookiecutter.json b/.cookiecutter.json index 0fc620e..5ca7475 100644 --- a/.cookiecutter.json +++ b/.cookiecutter.json @@ -1,5 +1,5 @@ { - "_commit": "802e9d5321387ec3a4d43ccccac95426c484b3bc", + "_commit": "7ade588e584688544482379ce3b50740f61702c3", "_template": "C:\\Users\\56kyl\\source\\repos\\cookiecutter-robust-python", "add_rust_extension": false, "author": "Kyle Oliver", diff --git a/.cruft.json b/.cruft.json index 440faa3..f6753b7 100644 --- a/.cruft.json +++ b/.cruft.json @@ -1,6 +1,6 @@ { "template": "C:\\Users\\56kyl\\source\\repos\\cookiecutter-robust-python", - "commit": "802e9d5321387ec3a4d43ccccac95426c484b3bc", + "commit": "7ade588e584688544482379ce3b50740f61702c3", "checkout": null, "context": { "cookiecutter": { @@ -18,7 +18,7 @@ "license": "MIT", "development_status": "Development Status :: 1 - Planning", "_template": "C:\\Users\\56kyl\\source\\repos\\cookiecutter-robust-python", - "_commit": "802e9d5321387ec3a4d43ccccac95426c484b3bc" + "_commit": "7ade588e584688544482379ce3b50740f61702c3" } }, "directory": null diff --git a/.github/workflows/docs-build.yml b/.github/workflows/build-docs.yml similarity index 66% rename from .github/workflows/docs-build.yml rename to .github/workflows/build-docs.yml index 6a29527..e7d5c3e 100644 --- a/.github/workflows/docs-build.yml +++ b/.github/workflows/build-docs.yml @@ -1,4 +1,4 @@ -# .github/workflows/docs-build.yml +# .github/workflows/build-docs.yml # See https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions name: Build Documentation @@ -6,14 +6,13 @@ name: Build Documentation on: pull_request: paths: - - "docs/**" # Documentation source files - - "src/**/*.py" # Code changes might impact API docs + - "docs/**" + - "src/**/*.py" - "noxfile.py" - "pyproject.toml" - - ".github/workflows/docs-build.yml" - # Include relevant config files that affect docs build - - ".ruff.toml" # Affects docstrings via linting - - "pyrightconfig.json" # Affects type hints in docs + - ".github/workflows/build-docs.yml" + - ".ruff.toml" # Affects docstrings via linting + - "pyrightconfig.json" # Affects type hints in docs push: branches: @@ -24,7 +23,7 @@ on: - "src/**/*.py" - "noxfile.py" - "pyproject.toml" - - ".github/workflows/docs-build.yml" + - ".github/workflows/build-docs.yml" workflow_dispatch: @@ -46,11 +45,10 @@ jobs: python-version-file: ".github/workflows/.python-version" - name: Build documentation - run: uvx nox -s docs-build + run: uvx nox -s build-docs - name: Upload documentation (HTML) Artifact uses: actions/upload-artifact@v4 with: name: html-docs path: docs/_build/html/ - retention-days: 5 diff --git a/.readthedocs.yml b/.readthedocs.yml new file mode 100644 index 0000000..20d4181 --- /dev/null +++ b/.readthedocs.yml @@ -0,0 +1,8 @@ +version: 2 + +build: + os: ubuntu-22.04 + tools: + python: "3.13" +sphinx: + configuration: docs/conf.py diff --git a/noxfile.py b/noxfile.py index 3008a34..fcf6aa8 100644 --- a/noxfile.py +++ b/noxfile.py @@ -128,7 +128,7 @@ def tests_python(session: Session) -> None: ) -@nox.session(python=DEFAULT_PYTHON_VERSION, name="docs-build", tags=[DOCS, BUILD]) +@nox.session(python=DEFAULT_PYTHON_VERSION, name="build-docs", tags=[DOCS, BUILD]) def docs_build(session: Session) -> None: """Build the project documentation (Sphinx).""" session.log("Installing documentation dependencies...") diff --git a/scripts/setup-remote.py b/scripts/setup-remote.py index 8f99759..c77fe43 100644 --- a/scripts/setup-remote.py +++ b/scripts/setup-remote.py @@ -52,3 +52,7 @@ def get_parser() -> argparse.ArgumentParser: parser.add_argument("-u", "--user", dest="github_user", help="GitHub user name.") parser.add_argument("-n", "--name", dest="repo_name", help="Name of the repo.") return parser + + +if __name__ == "__main__": + main() From 03b73878352cf541c7f0fe52a4c7fce249e2a829 Mon Sep 17 00:00:00 2001 From: Kyle Oliver Date: Sat, 26 Jul 2025 12:30:49 -0400 Subject: [PATCH 2/2] =?UTF-8?q?bump:=20version=200.14.0=20=E2=86=92=200.15?= =?UTF-8?q?.0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CHANGELOG.md | 2 ++ pyproject.toml | 2 +- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index dd2cec5..92982b3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,5 @@ +## v0.15.0 (2025-07-26) + ## v0.14.0 (2025-07-18) ## v0.13.0 (2025-07-18) diff --git a/pyproject.toml b/pyproject.toml index 85c7c1d..df06121 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [project] name = "robust-python-demo" -version = "0.14.0" +version = "0.15.0" description = "robust-python-demo" authors = [ { name = "Kyle Oliver", email = "56kyleoliver+cookiecutter-robust-python@gmail.com" },