Skip to content

Commit af1a01e

Browse files
committed
refactor: rename docs-build.yml to build-docs.yml to better follow the existing verb-type naming pattern that the other github actions follow
1 parent b3e7e38 commit af1a01e

File tree

3 files changed

+10
-11
lines changed

3 files changed

+10
-11
lines changed

tests/constants.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
"format-python",
2929
*TYPE_CHECK_NOX_SESSIONS,
3030
*TESTS_NOX_SESSIONS,
31-
"docs-build",
31+
"build-docs",
3232
"build-python",
3333
"build-container",
3434
"tox",

{{cookiecutter.project_name}}/.github/workflows/docs-build.yml renamed to {{cookiecutter.project_name}}/.github/workflows/build-docs.yml

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,18 @@
1-
# .github/workflows/docs-build.yml
1+
# .github/workflows/build-docs.yml
22
# See https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions
33

44
name: Build Documentation
55

66
on:
77
pull_request:
88
paths:
9-
- "docs/**" # Documentation source files
10-
- "src/**/*.py" # Code changes might impact API docs
9+
- "docs/**"
10+
- "src/**/*.py"
1111
- "noxfile.py"
1212
- "pyproject.toml"
13-
- ".github/workflows/docs-build.yml"
14-
# Include relevant config files that affect docs build
15-
- ".ruff.toml" # Affects docstrings via linting
16-
- "pyrightconfig.json" # Affects type hints in docs
13+
- ".github/workflows/build-docs.yml"
14+
- ".ruff.toml" # Affects docstrings via linting
15+
- "pyrightconfig.json" # Affects type hints in docs
1716

1817
push:
1918
branches:
@@ -24,7 +23,7 @@ on:
2423
- "src/**/*.py"
2524
- "noxfile.py"
2625
- "pyproject.toml"
27-
- ".github/workflows/docs-build.yml"
26+
- ".github/workflows/build-docs.yml"
2827

2928
workflow_dispatch:
3029

@@ -46,7 +45,7 @@ jobs:
4645
python-version-file: ".github/workflows/.python-version"
4746

4847
- name: Build documentation
49-
run: uvx nox -s docs-build
48+
run: uvx nox -s build-docs
5049

5150
- name: Upload documentation (HTML) Artifact
5251
uses: actions/upload-artifact@v4

{{cookiecutter.project_name}}/noxfile.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,7 @@ def tests_rust(session: Session) -> None:
171171

172172

173173
{% endif -%}
174-
@nox.session(python=DEFAULT_PYTHON_VERSION, name="docs-build", tags=[DOCS, BUILD])
174+
@nox.session(python=DEFAULT_PYTHON_VERSION, name="build-docs", tags=[DOCS, BUILD])
175175
def docs_build(session: Session) -> None:
176176
"""Build the project documentation (Sphinx)."""
177177
session.log("Installing documentation dependencies...")

0 commit comments

Comments
 (0)