From bdddb238f8328b87ab183e8f515dfc7c53fe3818 Mon Sep 17 00:00:00 2001 From: Kovid Goyal Date: Mon, 26 Apr 2021 13:35:22 +0530 Subject: [PATCH] Also generate a man page for kitty.conf --- docs/conf.py | 4 ++-- docs/conf.rst | 16 +++++++++++++--- docs/invocation.rst | 5 +++++ 3 files changed, 20 insertions(+), 5 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 2631febdb..743b9d067 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -167,8 +167,8 @@ html_show_sourcelink = False # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - ('invocation', 'kitty', 'kitty Documentation', - [author], 1) + ('invocation', 'kitty', 'kitty Documentation', [author], 1), + ('conf', 'kitty.conf', 'kitty.conf Documentation', [author], 5) ] diff --git a/docs/conf.rst b/docs/conf.rst index c7f99ecfe..7e0fcfd4a 100644 --- a/docs/conf.rst +++ b/docs/conf.rst @@ -39,6 +39,16 @@ expanded, so :code:`${USER}.conf` becomes :file:`name.conf` if Sample kitty.conf ^^^^^^^^^^^^^^^^^^^^^ -You can download a sample :file:`kitty.conf` file with all default settings and -comments describing each setting by clicking: :download:`sample kitty.conf -`. +.. only:: html + + You can download a sample :file:`kitty.conf` file with all default settings and + comments describing each setting by clicking: :download:`sample kitty.conf + `. + +.. only:: man + + You can edit a fully commented sample kitty.conf by pressing the + :sc:`edit_config_file` shortcut in kitty. This will generate a config + file with full documentation and all settings commented out. If you + have a pre-existing kitty.conf, then that will be used instead, delete + it to see the sample file. diff --git a/docs/invocation.rst b/docs/invocation.rst index 772d8da80..bdb7da92d 100644 --- a/docs/invocation.rst +++ b/docs/invocation.rst @@ -6,3 +6,8 @@ The kitty command line interface .. include:: generated/cli-kitty.rst .. include:: basic.rst + +See also +----------- + +See kitty.conf(5)