Skip to content

Commit 22e79a6

Browse files
committed
docs: consolidate CLI docs into command reference
1 parent 532bfcf commit 22e79a6

31 files changed

Lines changed: 690 additions & 311 deletions

docs/source/_static/css/custom.css

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -127,3 +127,34 @@ body[data-md-color-scheme="slate"] .home-tile p {
127127
box-shadow: 0 12px 26px rgba(2, 6, 23, 0.46);
128128
}
129129
}
130+
131+
.md-typeset dl.cli-reference {
132+
margin: 0.75rem 0 1.25rem;
133+
}
134+
135+
.md-typeset dl.cli-reference dt {
136+
margin: 0.85rem 0 0;
137+
font-weight: 500;
138+
}
139+
140+
.md-typeset dl.cli-reference dd {
141+
margin: 0.2rem 0 0.75rem 1.5rem;
142+
}
143+
144+
.md-typeset dl.cli-reference dd p {
145+
margin: 0;
146+
}
147+
148+
.md-typeset dl.cli-reference dd p + p {
149+
margin-top: 0.25rem;
150+
color: var(--md-default-fg-color--light);
151+
}
152+
153+
.md-typeset dl.cli-reference dt a,
154+
.md-typeset dl.cli-reference dt a:hover,
155+
.md-typeset dl.cli-reference dt a:focus,
156+
.md-typeset dl.cli-reference dt a:visited {
157+
color: inherit;
158+
text-decoration: none;
159+
border-bottom: 0;
160+
}

docs/source/api/cli_and_programmatic.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22

33
This page documents the public CLI-related imports from `pytask`.
44

5-
For command usage and options, see the [CLI reference](../commands/index.md).
5+
For command usage and options, see the
6+
[command reference](../reference_guides/commands.md).
67

78
## Command Line Entry Point
89

docs/source/commands/build.md

Lines changed: 0 additions & 39 deletions
This file was deleted.

docs/source/commands/clean.md

Lines changed: 0 additions & 35 deletions
This file was deleted.

docs/source/commands/collect.md

Lines changed: 0 additions & 35 deletions
This file was deleted.

docs/source/commands/dag.md

Lines changed: 0 additions & 34 deletions
This file was deleted.

docs/source/commands/index.md

Lines changed: 0 additions & 23 deletions
This file was deleted.

docs/source/commands/markers.md

Lines changed: 0 additions & 32 deletions
This file was deleted.

docs/source/commands/profile.md

Lines changed: 0 additions & 34 deletions
This file was deleted.

docs/source/how_to_guides/bp_complex_task_repetitions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -99,8 +99,8 @@ When you are using the `.name` attributes of the dimensions and multi-dimensiona
9999
objects like in the example above, you ensure that the names of dimensions are included
100100
in all downstream tasks.
101101

102-
Thus, you can simply call [`pytask -k`](../commands/build.md#options) with the following
103-
expression to execute all tasks related to the logit model.
102+
Thus, you can simply call [`pytask -k`](../reference_guides/commands.md#pytask-build--k)
103+
with the following expression to execute all tasks related to the logit model.
104104

105105
```console
106106
pytask -k logit

0 commit comments

Comments
 (0)