Skip to content

Commit 1dcf4b8

Browse files
committed
docs: move command to create config file to option lists
1 parent 6370a54 commit 1dcf4b8

File tree

2 files changed

+9
-8
lines changed

2 files changed

+9
-8
lines changed

docs/user-guide/install.md

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -66,14 +66,8 @@ uv run -- stagpy version
6666
```
6767

6868

69-
Some setup
70-
----------
71-
72-
Run the following to create a local config file (`.stagpy.toml`):
73-
74-
```sh title="shell"
75-
stagpy config --create
76-
```
69+
Shell completions
70+
-----------------
7771

7872
You can enable command-line auto-completion if you use either bash or zsh.
7973

scripts/gen_conf_list.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,13 @@ def print_config_list(fd: TextIO) -> None:
1414
importlib.reload(stagpy.config)
1515
from stagpy.config import Config
1616

17+
print("Run the following to create a local config file `.stagpy.toml`", file=fd)
18+
print('```sh title="shell"', file=fd)
19+
print("stagpy config --create", file=fd)
20+
print("```", file=fd)
21+
print(file=fd)
22+
print("Available options are described hereafter.", file=fd)
23+
1724
stagpy_conf = Config.default_()
1825
for sec_fld in fields(stagpy_conf):
1926
sec_name = sec_fld.name

0 commit comments

Comments
 (0)