mirrors/Nim
1
0
Fork 0
mirror of https://github.com/nim-lang/Nim.git synced 2025-12-30 18:02:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix #16901: sidebar groups now works with all routines, not just proc,func (#17416)

Browse Source 
* fix #16901: sidebar groups now works with all routines, not just proc,func

* fix tests
This commit is contained in:
Timothee Cour
2021-03-18 23:17:09 -07:00
committed by GitHub
parent 9e1a2e9b63
commit 452366982d
3 changed files with 91 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
compiler/docgen.nim
View File

@@ -1245,7 +1245,7 @@ proc genOutFile(d: PDoc, groupedToc = false): Rope =
renderTocEntries(d[], j, 1, tmp)
var toc = tmp.rope
for i in TSymKind:
var shouldSort = i in {skProc, skFunc} and groupedToc
var shouldSort = i in routineKinds and groupedToc
genSection(d, i, shouldSort)
toc.add(d.toc[i])
if toc != nil:

19
nimdoc/testproject/expected/subdir/subdir_b/utils.html
View File

@@ -121,12 +121,21 @@ window.addEventListener('DOMContentLoaded', main);
<li>
<a class="reference reference-toplevel" href="#18" id="68">Templates</a>
<ul class="simple simple-toc-section">
<ul class="simple nested-toc-section">aEnum
<li><a class="reference" href="#aEnum.t"
title="aEnum(): untyped">aEnum</a></li>
<li><a class="reference" href="#bEnum.t"
title="bEnum(): untyped">bEnum</a></li>
<li><a class="reference" href="#fromUtilsGen.t"
title="fromUtilsGen(): untyped">fromUtilsGen</a></li>
title="aEnum(): untyped">aEnum(): untyped</a></li>
</ul>
<ul class="simple nested-toc-section">fromUtilsGen
<li><a class="reference" href="#fromUtilsGen.t"
title="fromUtilsGen(): untyped">fromUtilsGen(): untyped</a></li>
</ul>
<ul class="simple nested-toc-section">bEnum
<li><a class="reference" href="#bEnum.t"
title="bEnum(): untyped">bEnum(): untyped</a></li>
</ul>
</ul>
</li>

104
nimdoc/testproject/expected/testproject.html
View File

@@ -309,56 +309,104 @@ window.addEventListener('DOMContentLoaded', main);
<li>
<a class="reference reference-toplevel" href="#14" id="64">Methods</a>
<ul class="simple simple-toc-section">
<ul class="simple nested-toc-section">method2
<li><a class="reference" href="#method2.e%2CMoo"
title="method2(self: Moo): int">method2(self: Moo): int</a></li>
</ul>
<ul class="simple nested-toc-section">method3
<li><a class="reference" href="#method3.e%2CMoo"
title="method3(self: Moo): int">method3(self: Moo): int</a></li>
</ul>
<ul class="simple nested-toc-section">method1
<li><a class="reference" href="#method1.e%2CMoo"
title="method1(self: Moo)">method1</a></li>
<li><a class="reference" href="#method2.e%2CMoo"
title="method2(self: Moo): int">method2</a></li>
<li><a class="reference" href="#method3.e%2CMoo"
title="method3(self: Moo): int">method3</a></li>
title="method1(self: Moo)">method1(self: Moo)</a></li>
</ul>
</ul>
</li>
<li>
<a class="reference reference-toplevel" href="#15" id="65">Iterators</a>
<ul class="simple simple-toc-section">
<ul class="simple nested-toc-section">iter2
<li><a class="reference" href="#iter2.i%2Cint"
title="iter2(n: int): int">iter2(n: int): int</a></li>
</ul>
<ul class="simple nested-toc-section">fromUtils1
<li><a class="reference" href="#fromUtils1.i"
title="fromUtils1(): int">fromUtils1</a></li>
<li><a class="reference" href="#iter1.i%2Cint"
title="iter1(n: int): int">iter1</a></li>
<li><a class="reference" href="#iter2.i%2Cint"
title="iter2(n: int): int">iter2</a></li>
title="fromUtils1(): int">fromUtils1(): int</a></li>
</ul>
<ul class="simple nested-toc-section">iter1
<li><a class="reference" href="#iter1.i%2Cint"
title="iter1(n: int): int">iter1(n: int): int</a></li>
</ul>
</ul>
</li>
<li>
<a class="reference reference-toplevel" href="#17" id="67">Macros</a>
<ul class="simple simple-toc-section">
<ul class="simple nested-toc-section">bar
<li><a class="reference" href="#bar.m"
title="bar(): untyped">bar</a></li>
<li><a class="reference" href="#z16.m"
title="z16()">z16</a></li>
<li><a class="reference" href="#z18.m"
title="z18(): int">z18</a></li>
title="bar(): untyped">bar(): untyped</a></li>
</ul>
<ul class="simple nested-toc-section">z18
<li><a class="reference" href="#z18.m"
title="z18(): int">z18(): int</a></li>
</ul>
<ul class="simple nested-toc-section">z16
<li><a class="reference" href="#z16.m"
title="z16()">z16()</a></li>
</ul>
</ul>
</li>
<li>
<a class="reference reference-toplevel" href="#18" id="68">Templates</a>
<ul class="simple simple-toc-section">
<ul class="simple nested-toc-section">fromUtils2
<li><a class="reference" href="#fromUtils2.t"
title="fromUtils2()">fromUtils2</a></li>
<li><a class="reference" href="#z6t.t"
title="z6t(): int">z6t</a></li>
<li><a class="reference" href="#foo.t%2CSomeType%2CSomeType"
title="foo(a, b: SomeType)">foo</a></li>
<li><a class="reference" href="#myfn.t"
title="myfn()">myfn</a></li>
<li><a class="reference" href="#z14.t"
title="z14()">z14</a></li>
<li><a class="reference" href="#z15.t"
title="z15()">z15</a></li>
<li><a class="reference" href="#testNimDocTrailingExample.t"
title="testNimDocTrailingExample()">testNimDocTrailingExample</a></li>
title="fromUtils2()">fromUtils2()</a></li>
</ul>
<ul class="simple nested-toc-section">z6t
<li><a class="reference" href="#z6t.t"
title="z6t(): int">z6t(): int</a></li>
</ul>
<ul class="simple nested-toc-section">z14
<li><a class="reference" href="#z14.t"
title="z14()">z14()</a></li>
</ul>
<ul class="simple nested-toc-section">z15
<li><a class="reference" href="#z15.t"
title="z15()">z15()</a></li>
</ul>
<ul class="simple nested-toc-section">foo
<li><a class="reference" href="#foo.t%2CSomeType%2CSomeType"
title="foo(a, b: SomeType)">foo(a, b: SomeType)</a></li>
</ul>
<ul class="simple nested-toc-section">myfn
<li><a class="reference" href="#myfn.t"
title="myfn()">myfn()</a></li>
</ul>
<ul class="simple nested-toc-section">testNimDocTrailingExample
<li><a class="reference" href="#testNimDocTrailingExample.t"
title="testNimDocTrailingExample()">testNimDocTrailingExample()</a></li>
</ul>
</ul>
</li>