Add some docs for the ssh kitten

This commit is contained in:
Kovid Goyal
2022-03-03 22:31:11 +05:30
parent 1c558be524
commit f1ce8c0e8a
7 changed files with 104 additions and 2 deletions

View File

@@ -200,6 +200,13 @@ def commit_role(
def write_cli_docs(all_kitten_names: Iterable[str]) -> None:
from kitty.cli import option_spec_as_rst
from kitty.launch import options_spec as launch_options_spec
from kittens.ssh.copy import option_text
from kittens.ssh.options.definition import copy_message
with open('generated/ssh-copy.rst', 'w') as f:
f.write(option_spec_as_rst(
appname='copy', ospec=option_text, heading_char='^',
usage='file-or-dir-to-copy ...', message=copy_message
))
with open('generated/launch.rst', 'w') as f:
f.write(option_spec_as_rst(
appname='launch', ospec=launch_options_spec, heading_char='_',