diff options
| author | Nicola Vitale <nivit@FreeBSD.org> | 2023-08-26 08:01:56 +0000 |
|---|---|---|
| committer | Nicola Vitale <nivit@FreeBSD.org> | 2023-08-26 08:01:56 +0000 |
| commit | b3504b217df4de1ae0b48e4619dac25694c7e42a (patch) | |
| tree | 8beb0a0591676437fbc4438b3015f10c2ca868ff | |
| parent | c3838cecddc629f42adcc2bba1dd3b5cb4ec719c (diff) | |
| download | ports-b3504b217df4de1ae0b48e4619dac25694c7e42a.tar.gz ports-b3504b217df4de1ae0b48e4619dac25694c7e42a.zip | |
x11/kitty: kitty.conf(5) manual page improvement
Add an OVERVIEW section to that manpage, so that the NAME section has
only few words. See for example the output when visiting
https://man.freebsd.org/cgi/man.cgi?query=kitty.conf&apropos=1
Current rendering:
https://user-images.githubusercontent.com/192271/260857832-927f7a50-a95a-4fb0-9092-d39d0e52f1b1.png
PR: 273248
Reported by: Graham Perrin <grahamperrin@gmail.com>
| -rw-r--r-- | x11/kitty/files/patch-docs_conf.py | 11 | ||||
| -rw-r--r-- | x11/kitty/files/patch-docs_conf.rst | 18 |
2 files changed, 28 insertions, 1 deletions
diff --git a/x11/kitty/files/patch-docs_conf.py b/x11/kitty/files/patch-docs_conf.py index a9775ffc7d43..58693f67f47e 100644 --- a/x11/kitty/files/patch-docs_conf.py +++ b/x11/kitty/files/patch-docs_conf.py @@ -1,5 +1,14 @@ ---- docs/conf.py.orig 2023-05-12 12:26:28 UTC +--- docs/conf.py.orig 2023-08-26 07:33:11 UTC +++ docs/conf.py +@@ -177,7 +177,7 @@ manpages_url = 'https://man7.org/linux/man-pages/man{s + # (source start file, name, description, authors, manual section). + man_pages = [ + ('invocation', 'kitty', 'kitty Documentation', [author], 1), +- ('conf', 'kitty.conf', 'kitty.conf Documentation', [author], 5) ++ ('conf', 'kitty.conf', 'kitty terminal emulator configuration file', [author], 5) + ] + + @@ -207,18 +207,10 @@ def commit_role( name: str, rawtext: str, text: str, lineno: int, inliner: Any, options: Any = {}, content: Any = [] ) -> Tuple[List[nodes.reference], List[nodes.problematic]]: diff --git a/x11/kitty/files/patch-docs_conf.rst b/x11/kitty/files/patch-docs_conf.rst new file mode 100644 index 000000000000..b205a7978b11 --- /dev/null +++ b/x11/kitty/files/patch-docs_conf.rst @@ -0,0 +1,18 @@ +--- docs/conf.rst.orig 1979-11-29 23:00:00 UTC ++++ docs/conf.rst +@@ -1,7 +1,14 @@ + kitty.conf +------------------------ ++================ + + .. highlight:: conf ++ ++ ++.. only:: man ++ ++ Overview ++ -------------- ++ + + |kitty| is highly customizable, everything from keyboard shortcuts, to rendering + frames-per-second. See below for an overview of all customization possibilities. |