Get rid of the |kitty.conf| substitution

This commit is contained in:
Kovid Goyal
2018-06-05 08:44:51 +05:30
parent 065a2b37c7
commit ea4a7136f0
6 changed files with 19 additions and 11 deletions

View File

@@ -17,6 +17,7 @@ from sphinx import addnodes
from sphinx.util.logging import getLogger
# config {{{
# -- Project information -----------------------------------------------------
project = 'kitty'
@@ -74,7 +75,6 @@ exclude_patterns = ['_build', 'Thumbs.db',
pygments_style = 'sphinx'
rst_prolog = '''
.. |kitty.conf| replace:: :doc:`kitty.conf </conf>`
.. |kitty| replace:: *kitty*
.. role:: green
.. role:: italic
@@ -193,6 +193,7 @@ texinfo_documents = [
author, 'kitty', 'One line description of project.',
'Miscellaneous'),
]
# }}}
# GitHub linking inlne roles {{{
@@ -356,6 +357,8 @@ def render_conf(conf_name, all_options):
kitty_mod = 'kitty_mod'
def render_group(group):
a('')
a(f'.. _conf-{conf_name}-{group.name}:')
a('')
a(group.short_text)
heading_level = '+' if '.' in group.name else '^'

View File

@@ -192,7 +192,7 @@ Currently, there are five layouts available,
You can switch between layouts using the :sc:`next_layout` key combination. You can
also create shortcuts to select particular layouts, and choose which layouts
you want to enable/disable, see |kitty.conf| for examples.
you want to enable/disable, see :ref:`conf-kitty-shortcuts.layout` for examples.
You can resize windows inside layouts. Press :sc:`start_resizing_window` to
enter resizing mode and follow the on-screen instructions. In a given window
@@ -203,7 +203,7 @@ but a row/column in the layout, all windows in that row/column will be resized.
Some layouts take options to control their behavior. For example, the ``fat``
and ``tall`` layouts accept the ``bias`` option to control how the available
space is split up. To specify the option, in |kitty.conf| use::
space is split up. To specify the option, in :opt:`kitty.conf <enabled_layouts>` use::
enabled_layouts tall:bias=70
@@ -301,7 +301,8 @@ specify individual families for the regular, bold, italic and bold+italic
fonts. You can even specify specific font families for specific ranges of
unicode characters. This allows precise control over text rendering. It can
come in handy for applications like powerline, without the need to use patched
fonts. See the various font related configuration directives in |kitty.conf|.
fonts. See the various font related configuration directives in
:ref:`conf-kitty-fonts`.
.. _scrollback:

View File

@@ -16,8 +16,8 @@ Start by running |kitty| as::
kitty -o allow_remote_control=yes --window-layout tall
In order for control to work, ``allow_remote_control`` must be enabled in
|kitty.conf|. Here we turn it on explicitly at the command line.
In order for control to work, :opt:`allow_remote_control` must be enabled in
:file:`kitty.conf`. Here we turn it on explicitly at the command line.
Now, in the new |kitty| window, enter the command::