Skip to content

Commit 6c96b5d

Browse files
committed
Rename nox tasks to be clearer what they do
1 parent 45d16a8 commit 6c96b5d

File tree

4 files changed

+9
-9
lines changed

4 files changed

+9
-9
lines changed

.github/workflows/checks.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ jobs:
4141
4242
- name: Link Check
4343
run: |
44-
poetry run -- nox -s docs:links:check
44+
poetry run -- nox -s links:check
4545
4646
4747
Changelog:

doc/changes/changes_1.6.0.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@
55
### Links in the Documentation
66
This version of the PTB adds nox tasks to check links present in our documentation:
77

8-
docs:link - List all the links within the documentation
9-
docs:links:check - Checks whether all links in the documentation are accessible
8+
links:list - List all the links within the documentation
9+
links:check - Checks whether all links in the documentation are accessible
1010

11-
`docs:links:check` is run in the CI `checks.yml`. If this step fails in the CI,
11+
`links:check` is run in the CI `checks.yml`. If this step fails in the CI,
1212
please check the output & manually resolve the issues. There might be some cases
1313
where you need to update your doc/conf.py with specific values for the allowed
1414
options for the [Linkcheck Builder](https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-the-linkcheck-builder).

exasol/toolbox/nox/_documentation.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ def _docs_links_check(doc_config: Path, args):
143143
)
144144

145145

146-
@nox.session(name="docs:links", python=False)
146+
@nox.session(name="links:list", python=False)
147147
def docs_list_links(session: Session) -> None:
148148
"""List all the links within the documentation."""
149149
r_code, text = _docs_list_links(PROJECT_CONFIG.doc)
@@ -152,12 +152,12 @@ def docs_list_links(session: Session) -> None:
152152
session.error()
153153

154154

155-
@nox.session(name="docs:links:check", python=False)
155+
@nox.session(name="links:check", python=False)
156156
def docs_links_check(session: Session) -> None:
157157
"""Checks whether all links in the documentation are accessible."""
158158
parser = argparse.ArgumentParser(
159-
prog="nox -s docs:links:check",
160-
usage="nox -s docs:links:check -- [-h] [-o |--output]",
159+
prog="nox -s links:check",
160+
usage="nox -s links:check -- [-h] [-o |--output]",
161161
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
162162
)
163163
parser.add_argument(

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ jobs:
4040
4141
- name: Link Check
4242
run: |
43-
poetry run -- nox -s docs:links:check
43+
poetry run -- nox -s links:check
4444
4545
build-matrix:
4646
name: Generate Build Matrix

0 commit comments

Comments
 (0)