IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

[manpage] emit OSC 8 hyperlinks via groff (#12108)

Browse Source 
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
This commit is contained in:
Johannes Altmanninger 2024-03-17 10:55:04 +01:00 committed by GitHub
parent e2ad48a521
commit 22968d29f5
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 14 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
CHANGES.rst
View File

@ -35,6 +35,12 @@ Features added
* #11981: Improve rendering of signatures using ``slice`` syntax, * #11981: Improve rendering of signatures using ``slice`` syntax,
e.g., ``def foo(arg: np.float64[:,:]) -> None: ...``. e.g., ``def foo(arg: np.float64[:,:]) -> None: ...``.
* The manpage builder now adds `OSC 8`_ anchors to hyperlinks, using
the `groff`_ device control command.
.. _OSC 8: https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda
.. _groff: https://lists.gnu.org/archive/html/groff/2021-10/msg00000.html
Bugs fixed Bugs fixed
---------- ----------

9
sphinx/writers/manpage.py
View File

@ -308,13 +308,17 @@ class ManualPageTranslator(SphinxTranslator, BaseTranslator):
# overwritten -- don't visit inner marked up nodes # overwritten -- don't visit inner marked up nodes
def visit_reference(self, node: Element) -> None: def visit_reference(self, node: Element) -> None:
uri = node.get('refuri', '')
if uri:
# OSC 8 link start (using groff's device control directive).
self.body.append(fr"\X'tty: link {uri}'")
self.body.append(self.defs['reference'][0]) self.body.append(self.defs['reference'][0])
# avoid repeating escaping code... fine since # avoid repeating escaping code... fine since
# visit_Text calls astext() and only works on that afterwards # visit_Text calls astext() and only works on that afterwards
self.visit_Text(node) # type: ignore[arg-type] self.visit_Text(node) # type: ignore[arg-type]
self.body.append(self.defs['reference'][1]) self.body.append(self.defs['reference'][1])
uri = node.get('refuri', '')
if uri.startswith(('mailto:', 'http:', 'https:', 'ftp:')): if uri.startswith(('mailto:', 'http:', 'https:', 'ftp:')):
# if configured, put the URL after the link # if configured, put the URL after the link
if self.config.man_show_urls and node.astext() != uri: if self.config.man_show_urls and node.astext() != uri:
@ -324,6 +328,9 @@ class ManualPageTranslator(SphinxTranslator, BaseTranslator):
' <', ' <',
self.defs['strong'][0], uri, self.defs['strong'][1], self.defs['strong'][0], uri, self.defs['strong'][1],
'>']) '>'])
if uri:
# OSC 8 link end.
self.body.append(r"\X'tty: link'")
raise nodes.SkipNode raise nodes.SkipNode
def visit_number_reference(self, node: Element) -> None: def visit_number_reference(self, node: Element) -> None: