Skip to content

Commit 0ea3cee

Browse files
authored
docs: consolidate CLI docs into command reference (#858)
1 parent 532bfcf commit 0ea3cee

44 files changed

Lines changed: 461 additions & 516 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,3 +30,4 @@ tests/test_jupyter/*.txt
3030
.venv
3131
docs/jupyter_execute
3232
.DS_Store
33+
docs/source/reference_guides/commands.md

.pre-commit-config.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ repos:
5353
mdformat-pyproject>=0.0.2,
5454
]
5555
files: (docs/.)
56-
exclude: (docs/source/reference_guides/hookspecs\.md|docs/source/api/.*\.md|docs/source/how_to_guides/capture_warnings\.md|docs/source/how_to_guides/hashing_inputs_of_tasks\.md|docs/source/how_to_guides/provisional_nodes_and_task_generators\.md|docs/source/how_to_guides/remote_files\.md|docs/source/how_to_guides/writing_custom_nodes\.md|docs/source/tutorials/defining_dependencies_products\.md|docs/source/tutorials/using_a_data_catalog\.md)
56+
exclude: (docs/source/reference_guides/hookspecs\.md|docs/source/reference_guides/api/.*\.md|docs/source/how_to_guides/capture_warnings\.md|docs/source/how_to_guides/hashing_inputs_of_tasks\.md|docs/source/how_to_guides/provisional_nodes_and_task_generators\.md|docs/source/how_to_guides/remote_files\.md|docs/source/how_to_guides/writing_custom_nodes\.md|docs/source/tutorials/defining_dependencies_products\.md|docs/source/tutorials/using_a_data_catalog\.md)
5757
- repo: https://github.com/kynan/nbstripout
5858
rev: 0.9.1
5959
hooks:

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/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.

0 commit comments

Comments
 (0)