Skip to content

Commit

Permalink
Rename CSS classes for return type hint HTML markup.
Browse files Browse the repository at this point in the history
Wrap the complete type hint in a additional <span> to enable showing the
typehint as a popup on hover.

Port changes to sphinx/writers/html.py.
  • Loading branch information
doerwalter committed May 16, 2021
1 parent 643131a commit cf2d5b3
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions sphinx/writers/html.py
Original file line number Diff line number Diff line change
Expand Up @@ -174,10 +174,10 @@ def depart_desc_type(self, node: Element) -> None:
pass

def visit_desc_returns(self, node: Element) -> None:
self.body.append(' &#x2192; ')
self.body.append(' <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint">')

def depart_desc_returns(self, node: Element) -> None:
pass
self.body.append('</span></span>')

def visit_desc_parameterlist(self, node: Element) -> None:
self.body.append('<span class="sig-paren">(</span>')
Expand Down
4 changes: 2 additions & 2 deletions sphinx/writers/html5.py
Original file line number Diff line number Diff line change
Expand Up @@ -145,10 +145,10 @@ def depart_desc_type(self, node: Element) -> None:
pass

def visit_desc_returns(self, node: Element) -> None:
self.body.append(' <span class="sig-arrow">&#x2192;</span> <span class="sig-returns">')
self.body.append(' <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint">')

def depart_desc_returns(self, node: Element) -> None:
self.body.append('</span>')
self.body.append('</span></span>')

def visit_desc_parameterlist(self, node: Element) -> None:
self.body.append('<span class="sig-paren">(</span>')
Expand Down

0 comments on commit cf2d5b3

Please sign in to comment.