Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .cookiecutter.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"_commit": "802e9d5321387ec3a4d43ccccac95426c484b3bc",
"_commit": "7ade588e584688544482379ce3b50740f61702c3",
"_template": "C:\\Users\\56kyl\\source\\repos\\cookiecutter-robust-python",
"add_rust_extension": false,
"author": "Kyle Oliver",
Expand Down
4 changes: 2 additions & 2 deletions .cruft.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"template": "C:\\Users\\56kyl\\source\\repos\\cookiecutter-robust-python",
"commit": "802e9d5321387ec3a4d43ccccac95426c484b3bc",
"commit": "7ade588e584688544482379ce3b50740f61702c3",
"checkout": null,
"context": {
"cookiecutter": {
Expand All @@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -1,19 +1,18 @@
# .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

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:
Expand All @@ -24,7 +23,7 @@ on:
- "src/**/*.py"
- "noxfile.py"
- "pyproject.toml"
- ".github/workflows/docs-build.yml"
- ".github/workflows/build-docs.yml"

workflow_dispatch:

Expand All @@ -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
8 changes: 8 additions & 0 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
version: 2

build:
os: ubuntu-22.04
tools:
python: "3.13"
sphinx:
configuration: docs/conf.py
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## v0.15.0 (2025-07-18)
## v0.15.0 (2025-07-26)

## v0.14.0 (2025-07-18)

Expand Down
2 changes: 1 addition & 1 deletion noxfile.py
Original file line number Diff line number Diff line change
Expand Up @@ -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...")
Expand Down
4 changes: 4 additions & 0 deletions scripts/setup-remote.py
Original file line number Diff line number Diff line change
Expand Up @@ -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()
Loading