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

Merge pull request #9225 from doerwalter/typehint-html

Browse Source 
Add HTML markup to method/function return typehint
This commit is contained in:
Takeshi KOMIYA 2021-07-11 12:03:40 +09:00 committed by GitHub
commit f40c2837dc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 21 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
sphinx/writers/html.py
View File

@ -174,10 +174,12 @@ class HTMLTranslator(SphinxTranslator, BaseTranslator):
pass pass
def visit_desc_returns(self, node: Element) -> None: def visit_desc_returns(self, node: Element) -> None:
self.body.append(' &#x2192; ') self.body.append(' <span class="sig-return">')
self.body.append('<span class="sig-return-icon">&#x2192;</span>')
self.body.append(' <span class="sig-return-typehint">')
def depart_desc_returns(self, node: Element) -> None: def depart_desc_returns(self, node: Element) -> None:
pass self.body.append('</span></span>')
def visit_desc_parameterlist(self, node: Element) -> None: def visit_desc_parameterlist(self, node: Element) -> None:
self.body.append('<span class="sig-paren">(</span>') self.body.append('<span class="sig-paren">(</span>')

6
sphinx/writers/html5.py
View File

@ -145,10 +145,12 @@ class HTML5Translator(SphinxTranslator, BaseTranslator):
pass pass
def visit_desc_returns(self, node: Element) -> None: def visit_desc_returns(self, node: Element) -> None:
self.body.append(' &#x2192; ') self.body.append(' <span class="sig-return">')
self.body.append('<span class="sig-return-icon">&#x2192;</span>')
self.body.append(' <span class="sig-return-typehint">')
def depart_desc_returns(self, node: Element) -> None: def depart_desc_returns(self, node: Element) -> None:
pass self.body.append('</span></span>')
def visit_desc_parameterlist(self, node: Element) -> None: def visit_desc_parameterlist(self, node: Element) -> None:
self.body.append('<span class="sig-paren">(</span>') self.body.append('<span class="sig-paren">(</span>')

1
tests/roots/test-html_signaturereturn_icon/conf.py Normal file
View File

@ -0,0 +1 @@
extensions = ['sphinx.ext.autodoc']

4
tests/roots/test-html_signaturereturn_icon/index.rst Normal file
View File

@ -0,0 +1,4 @@
test-html_signaturereturn_icon
==============================
.. py:function:: foo(a: bool, b: int) -> str

8
tests/test_build_html.py
View File

@ -1635,3 +1635,11 @@ def test_html_permalink_icon(app):
assert ('<h1>The basic Sphinx documentation for testing<a class="headerlink" ' assert ('<h1>The basic Sphinx documentation for testing<a class="headerlink" '
'href="#the-basic-sphinx-documentation-for-testing" ' 'href="#the-basic-sphinx-documentation-for-testing" '
'title="Permalink to this headline"><span>[PERMALINK]</span></a></h1>' in content) 'title="Permalink to this headline"><span>[PERMALINK]</span></a></h1>' in content)
@pytest.mark.sphinx('html', testroot='html_signaturereturn_icon')
def test_html_signaturereturn_icon(app):
app.build()
content = (app.outdir / 'index.html').read_text()
assert ('<span class="sig-return-icon">&#x2192;</span>' in content)