Skip to content

Commit

Permalink
x11/kitty: kitty.conf(5) manual page improvement
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
nivit committed Aug 26, 2023
1 parent c3838ce commit b3504b2
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 1 deletion.
11 changes: 10 additions & 1 deletion 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]]:
Expand Down
18 changes: 18 additions & 0 deletions 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.

0 comments on commit b3504b2

Please sign in to comment.