Documentation placeholder for the new launch interface

This commit is contained in:
Kovid Goyal 2019-11-13 10:09:43 +05:30
parent 6aa82d82ad
commit d84da6b7b8
No known key found for this signature in database
GPG Key ID: 06BC317B515ACE7C
2 changed files with 15 additions and 0 deletions

View File

@ -243,7 +243,15 @@ def add_html_context(app, pagename, templatename, context, *args):
# CLI docs {{{
def write_cli_docs(all_kitten_names):
from kitty.launch import options_spec as launch_options_spec
from kitty.cli import option_spec_as_rst
with open('generated/launch.rst', 'w') as f:
f.write(option_spec_as_rst(
appname='launch', ospec=launch_options_spec, heading_char='_',
message='''\
Launch an arbitrary program in a new kitty window/tab
'''
))
with open('generated/cli-kitty.rst', 'w') as f:
f.write(option_spec_as_rst(appname='kitty').replace(
'kitty --to', 'kitty @ --to'))

7
docs/launch.rst Normal file
View File

@ -0,0 +1,7 @@
Launching programs in new windows/tabs
========================================
Syntax reference
------------------
.. include:: /generated/launch.rst