From 79c03c4e6011e8fa26b7977e22739f898ee6b84e Mon Sep 17 00:00:00 2001 From: arthur-tacca Date: Thu, 29 Feb 2024 11:03:29 +0000 Subject: [PATCH 1/4] Add module name to doc source (to allow intersphinx usage) --- doc/conf.py | 1 + doc/index.rst | 1 + 2 files changed, 2 insertions(+) diff --git a/doc/conf.py b/doc/conf.py index 7984bc22..4757c54f 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -26,6 +26,7 @@ intersphinx_mapping = {'py': ('https://docs.python.org/3.12', None)} +add_module_names = False # -- Options for HTML output ------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output diff --git a/doc/index.rst b/doc/index.rst index 4bd8c702..63082ddd 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -1,3 +1,4 @@ +.. module:: typing_extensions Welcome to typing_extensions's documentation! ============================================= From 93db2e26805fa27452a4ab6d20653f7984ec7135 Mon Sep 17 00:00:00 2001 From: arthur-tacca Date: Thu, 29 Feb 2024 13:18:31 +0000 Subject: [PATCH 2/4] Add back old unprefixed link targets --- doc/conf.py | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/doc/conf.py b/doc/conf.py index 4757c54f..180cc775 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -32,4 +32,17 @@ # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output html_theme = 'alabaster' -html_static_path = ['_static'] + +from sphinx.writers.html import HTMLTranslator +from docutils.nodes import Element, Node, Text + +class MyTranslator(HTMLTranslator): + """Adds a link target to name without `typing_extensions.` prefix.""" + def visit_desc_signature(self, node: Element) -> None: + desc_name = node.get("fullname") + if desc_name: + self.body.append(f'') + super().visit_desc_signature(node) + +def setup(app): + app.set_translator('html', MyTranslator) From 4441b414ac74f5bb9b9d0c621f620dbfa077da07 Mon Sep 17 00:00:00 2001 From: arthur-tacca Date: Fri, 1 Mar 2024 22:38:22 +0000 Subject: [PATCH 3/4] Docs: use correct translator (makes small difference to font) --- doc/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/conf.py b/doc/conf.py index 180cc775..dab6d4a7 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -33,10 +33,10 @@ html_theme = 'alabaster' -from sphinx.writers.html import HTMLTranslator +from sphinx.writers.html5 import HTML5Translator from docutils.nodes import Element, Node, Text -class MyTranslator(HTMLTranslator): +class MyTranslator(HTML5Translator): """Adds a link target to name without `typing_extensions.` prefix.""" def visit_desc_signature(self, node: Element) -> None: desc_name = node.get("fullname") From 8c447ee73af3e820f99ce9900a06eff8357edab4 Mon Sep 17 00:00:00 2001 From: arthur-tacca Date: Fri, 1 Mar 2024 22:42:02 +0000 Subject: [PATCH 4/4] Fix flake8 issues in conf.py --- doc/conf.py | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/doc/conf.py b/doc/conf.py index dab6d4a7..40d3c6b7 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -5,6 +5,8 @@ import os.path import sys +from sphinx.writers.html5 import HTML5Translator +from docutils.nodes import Element sys.path.insert(0, os.path.abspath('.')) @@ -33,8 +35,6 @@ html_theme = 'alabaster' -from sphinx.writers.html5 import HTML5Translator -from docutils.nodes import Element, Node, Text class MyTranslator(HTML5Translator): """Adds a link target to name without `typing_extensions.` prefix.""" @@ -44,5 +44,6 @@ def visit_desc_signature(self, node: Element) -> None: self.body.append(f'') super().visit_desc_signature(node) + def setup(app): - app.set_translator('html', MyTranslator) + app.set_translator('html', MyTranslator)