Add links to kitten source code

This commit is contained in:
Kovid Goyal 2021-07-24 08:15:52 +05:30
parent ff191c9404
commit 85e028cab1
No known key found for this signature in database
GPG Key ID: 06BC317B515ACE7C
9 changed files with 15 additions and 33 deletions

View File

@ -246,6 +246,11 @@ if you specify a program-to-run you can use the special placeholder
with open(f'generated/cli-kitten-{kitten}.rst', 'w') as f: with open(f'generated/cli-kitten-{kitten}.rst', 'w') as f:
p = partial(print, file=f) p = partial(print, file=f)
p('.. program::', f'kitty +kitten {kitten}') p('.. program::', f'kitty +kitten {kitten}')
p(f'\nSource code for {kitten}')
p('-' * 72)
p(f'\nThe source code for this kitten is `available on GitHub <https://github.com/kovidgoyal/kitty/tree/master/kittens/{kitten}>`_.')
p('\nCommand Line Interface')
p('-' * 72, file=f)
p('\n\n' + option_spec_as_rst( p('\n\n' + option_spec_as_rst(
data['options'], message=data['help_text'], usage=data['usage'], appname=f'kitty +kitten {kitten}', data['options'], message=data['help_text'], usage=data['usage'], appname=f'kitty +kitten {kitten}',
heading_char='^')) heading_char='^'))

View File

@ -19,7 +19,4 @@ are selected.
.. program:: kitty +kitten broadcast .. program:: kitty +kitten broadcast
Command Line Interface
--------------------------
.. include:: /generated/cli-kitten-broadcast.rst .. include:: /generated/cli-kitten-broadcast.rst

View File

@ -23,7 +23,4 @@ use::
.. program:: kitty +kitten clipboard .. program:: kitty +kitten clipboard
Command Line Interface
--------------------------
.. include:: /generated/cli-kitten-clipboard.rst .. include:: /generated/cli-kitten-clipboard.rst

View File

@ -142,9 +142,6 @@ configuration directives.
.. include:: /generated/conf-kitten-diff.rst .. include:: /generated/conf-kitten-diff.rst
Command Line Interface
-------------------------
.. include:: /generated/cli-kitten-diff.rst .. include:: /generated/cli-kitten-diff.rst

View File

@ -88,16 +88,14 @@ Now run kitty with::
When you press the :kbd:`F1` key you will be able to select a word to When you press the :kbd:`F1` key you will be able to select a word to
look it up in the Google dictionary. look it up in the Google dictionary.
Command Line Interface
-------------------------
To avoid having to specify the same command line options on ever invocation,
you can use the :opt:`kitten_alias` option in :file:`kitty.conf` to create aliases
that have common sets of options. For example::
kitten_alias myhints hints --alphabet qfjdkslaureitywovmcxzpq1234567890
Documentation for the full set of options is below.
.. include:: ../generated/cli-kitten-hints.rst .. include:: ../generated/cli-kitten-hints.rst
.. note::
To avoid having to specify the same command line options on ever invocation,
you can use the :opt:`kitten_alias` option in :file:`kitty.conf` to create aliases
that have common sets of options. For example::
kitten_alias myhints hints --alphabet qfjdkslaureitywovmcxzpq1234567890
Documentation for the full set of options is below.

View File

@ -37,7 +37,4 @@ The ``icat`` kitten has various command line arguments to allow it to be used
from inside other programs to display images. In particular, :option:`--place`, from inside other programs to display images. In particular, :option:`--place`,
:option:`--detect-support` and :option:`--print-window-size`. :option:`--detect-support` and :option:`--print-window-size`.
Command Line Interface
--------------------------
.. include:: /generated/cli-kitten-icat.rst .. include:: /generated/cli-kitten-icat.rst

View File

@ -37,7 +37,4 @@ print out ``Hello, world!``. You can make the terminal program as complex as
you like, as demonstrated in the screenshot above. you like, as demonstrated in the screenshot above.
Command Line Interface
-------------------------
.. include:: ../generated/cli-kitten-panel.rst .. include:: ../generated/cli-kitten-panel.rst

View File

@ -15,7 +15,4 @@ for *XTGETTCAP* to see the syntax for the escape code and read the source
of this kitten to find the values of the keys for the various queries. of this kitten to find the values of the keys for the various queries.
Command Line Interface
-------------------------
.. include:: ../generated/cli-kitten-query_terminal.rst .. include:: ../generated/cli-kitten-query_terminal.rst

View File

@ -28,7 +28,4 @@ You can switch between modes using either the function keys or by pressing
:kbd:`Ctrl+Shift+Tab`. :kbd:`Ctrl+Shift+Tab`.
Command Line Interface
-------------------------
.. include:: ../generated/cli-kitten-unicode_input.rst .. include:: ../generated/cli-kitten-unicode_input.rst