Skip to content

Commit 099510f

Browse files
committed
Fix docs build failure
dynamic_background_opacity needs to be its own option in the conf docs.
1 parent 35c6014 commit 099510f

File tree

2 files changed

+9
-4
lines changed

2 files changed

+9
-4
lines changed

docs/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,7 @@
180180
# }}}
181181

182182

183-
# GitHub linking inlne roles {{{
183+
# GitHub linking inline roles {{{
184184

185185
def num_role(which, name, rawtext, text, lineno, inliner, options={}, content=[]):
186186
' Link to a github issue '

kitty/config_data.py

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -698,10 +698,15 @@ def tab_fade(x):
698698
the escape codes to set the terminals default colors in a shell script to
699699
launch your editor. Be aware that using a value less than 1.0 is a (possibly
700700
significant) performance hit. If you want to dynamically change transparency
701-
of windows set dynamic_background_opacity to yes (this is off by default as it
702-
has a performance cost)
701+
of windows set :opt:`dynamic_background_opacity` to :code:`yes` (this is off by
702+
default as it has a performance cost)
703+
'''))
704+
705+
o('dynamic_background_opacity', False, long_text=_('''
706+
Allow changing of the :opt:`background_opacity` dynamically, using either keyboard
707+
shortcuts (:sc:`increase_background_opacity` and :sc:`decrease_background_opacity`)
708+
or the remote control facility.
703709
'''))
704-
o('dynamic_background_opacity', False)
705710

706711
o('dim_opacity', 0.75, option_type=unit_float, long_text=_('''
707712
How much to dim text that has the DIM/FAINT attribute set. One means no dimming and

0 commit comments

Comments
 (0)