jyapayne/Nim
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

fix #9102 docgen: sidebar now shows proc signatures instead of encoding (#16857)

Browse source
This commit is contained in:
Timothee Cour 2021-01-28 23:42:19 -08:00 • committed by GitHub
commit 44f672a515
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
7 changed files with 981 additions and 37 deletions
Download patch file Download diff file Expand all files Collapse all files

8
config/nimdoc.cfg
View file

@ -34,7 +34,8 @@ doc.section.toc2 = """
# Available variables are:
# * $desc: the actual docstring of the item.
# * $header: the full version of name, including types, pragmas, tags, etc.
# * $header_plain: like header but without HTML, for attribute embedding.
# * $header_plain: like header but without HTML (and without pragmas, tags, etc.),
# for attribute embedding.
# * $itemID: numerical unique entry of the item in the HTML.
# * $itemSym: short symbolic name of the item for easier hyperlinking.
# * $itemSymEnc: quoted version for URLs or attributes.
@ -55,6 +56,9 @@ $seeSrc
# Chunk of HTML emitted for each entry in the HTML table of contents.
# See doc.item for available substitution variables.
# This is used for TOC items which are not overloadable (e.g. types).
# `$header_plain` would be too verbose here, so we use $name.
doc.item.toc = """
<li><a class="reference" href="#$itemSymOrIDEnc"
title="$header_plain">$name</a></li>
@ -63,7 +67,7 @@ doc.item.toc = """
# This is used for TOC items which are grouped by the same name (e.g. procs).
doc.item.tocTable = """
<li><a class="reference" href="#$itemSymOrIDEnc"
title="$header_plain">$itemSymOrID</a></li>
title="$header_plain">$header_plain</a></li>
"""