Skip to content

Commit 1a0bb0e

Browse files
authored
docs: split cli reference for each sub command (#898)
1 parent 256119f commit 1a0bb0e

File tree

6 files changed

+36
-8
lines changed

6 files changed

+36
-8
lines changed

docs/cli/index.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# CLI Reference
22

3-
```{eval-rst}
4-
.. click:: ss_python.cli:cli
5-
:prog: ss-python-cli
6-
:nested: full
3+
```{toctree}
4+
:maxdepth: 1
5+
ss_python
6+
run
77
```

docs/cli/run.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Serious Scaffold Python Run
2+
3+
```{eval-rst}
4+
.. click:: ss_python.cli:run
5+
:prog: ss-python-cli run
6+
:nested: full
7+
```

docs/cli/ss_python.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Serious Scaffold Python
2+
3+
```{eval-rst}
4+
.. click:: ss_python.cli:cli
5+
:prog: ss-python-cli
6+
:nested: short
7+
```

template/docs/cli/index.md.jinja

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# CLI Reference
22

3-
```{eval-rst}
4-
.. click:: {{ module_name }}.cli:cli
5-
:prog: {{ package_name }}-cli
6-
:nested: full
3+
```{toctree}
4+
:maxdepth: 1
5+
{{ module_name }}
6+
run
77
```

template/docs/cli/run.md.jinja

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# {{ project_name }} Run
2+
3+
```{eval-rst}
4+
.. click:: {{ module_name }}.cli:run
5+
:prog: {{ package_name }}-cli run
6+
:nested: full
7+
```
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# {{ project_name }}
2+
3+
```{eval-rst}
4+
.. click:: {{ module_name }}.cli:cli
5+
:prog: {{ package_name }}-cli
6+
:nested: short
7+
```

0 commit comments

Comments
 (0)