Skip to content

Commit 00b331e

Browse files
committed
Rename nox tasks build-docs to docs:build
1 parent bb90d1c commit 00b331e

File tree

4 files changed

+5
-5
lines changed

4 files changed

+5
-5
lines changed

.github/workflows/checks.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ jobs:
3838

3939
- name: Build Documentation
4040
run: |
41-
poetry run python -m nox -s build-docs
41+
poetry run python -m nox -s docs:build
4242
4343
Lint:
4444
name: Linting (Python-${{ matrix.python-version }})

doc/user_guide/getting_started.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ Build and open the documentation:
7171

7272
.. code-block:: shell
7373
74-
nox -s build-docs open-docs
74+
nox -s docs:build open-docs
7575
7676
Execute the unit tests of the project:
7777

@@ -191,7 +191,7 @@ You are ready to use the toolbox. With *nox -l* you can list all available tasks
191191
- unit-tests -> Runs all unit tests
192192
- integration-tests -> Runs the all integration tests
193193
- coverage -> Runs all tests (unit + integration) and reports the code coverage
194-
- build-docs -> Builds the project documentation
194+
- docs:build -> Builds the project documentation
195195
- open-docs -> Opens the built project documentation
196196
- clean-docs -> Removes the documentations build folder
197197
- report -> Collects and generates a metrics summary for the workspace

exasol/toolbox/nox/_documentation.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ def build_docs(session: Session) -> None:
4242
_build_multiversion_docs(session, PROJECT_CONFIG)
4343

4444

45-
@nox.session(name="build-docs", python=False)
45+
@nox.session(name="docs:build", python=False)
4646
def build_docs(session: Session) -> None:
4747
"""Builds the project documentation"""
4848
_build_docs(session, PROJECT_CONFIG)

exasol/toolbox/templates/github/workflows/checks.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ jobs:
4444

4545
- name: Build Documentation
4646
run: |
47-
poetry run python -m nox -s build-docs
47+
poetry run python -m nox -s docs:build
4848
4949
Lint:
5050
name: Linting (Python-${{ matrix.python-version }})

0 commit comments

Comments
 (0)