From e7e8f437c4f95f4f5d038cdddf5036462733288a Mon Sep 17 00:00:00 2001 From: JJ <35242550+j-james@users.noreply.github.com> Date: Wed, 15 Jun 2022 06:40:56 -0700 Subject: [PATCH] Keep the doc sidebar on the screen while scrolling (#19851) * [docgen] Group sidebar sections into
(open by default) * [docgen] Consistent indentation in generated HTML (this is a boon for working on docgen's html/css output) * [docgen] Move Source/Edit buttons inside main div This makes styling the documentation significantly easier. * [docgen] Somewhat consistent CSS formatting * [docgen] Keep the sidebar onscreen while scrolling * [docgen] Tweak CSS for the sticky sidebar * [docgen] search type=text ==> type=search * [docgen] Update expected doc output * [docgen] Fix Group by Type sidebar placement bug * [docgen] Curse you, whitespace (fix tests) * [docgen] Fix rst2html tests Co-authored-by: sandytypical <43030857+xflywind@users.noreply.github.com> --- config/nimdoc.cfg | 216 ++- doc/nimdoc.css | 164 +- nimdoc/rst2html/expected/rst_examples.html | 85 +- .../expected/index.html | 122 +- .../expected/theindex.html | 24 +- nimdoc/testproject/expected/nimdoc.out.css | 164 +- .../expected/subdir/subdir_b/utils.html | 758 ++++----- nimdoc/testproject/expected/testproject.html | 1454 ++++++++--------- nimdoc/testproject/expected/theindex.html | 24 +- 9 files changed, 1401 insertions(+), 1610 deletions(-) diff --git a/config/nimdoc.cfg b/config/nimdoc.cfg index 4efa1f637..725f9e0a5 100644 --- a/config/nimdoc.cfg +++ b/config/nimdoc.cfg @@ -9,25 +9,28 @@ split.item.toc = "20" doc.section = """
-

$sectionTitle

-
-$content -
+

$sectionTitle

+
+ $content +
+ """ doc.section.toc = """
  • - $sectionTitle - +
    + $sectionTitle +
      + $content +
    +
    • """ doc.section.toc2 = """ - + """ # Chunk of HTML emitted for each entry in the HTML table of contents. @@ -47,12 +50,12 @@ doc.section.toc2 = """ doc.item = """
    -
    $header
    -
    -$deprecationMsg -$desc -$seeSrc -
    + 
    $header
    +
    + $deprecationMsg + $desc + $seeSrc +
    """ @@ -61,9 +64,8 @@ $seeSrc # * $overloadGroupName - the anchor for this whole group # * $content - string containing `doc.item`s themselves doc.item2 = """ -
    -$content + $content
    """ @@ -73,18 +75,14 @@ $content # 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 = """ -
  • $name
    • +
  • $name
    • """ # This is used for TOC items which are grouped by the same name (e.g. procs). doc.item.tocTable = """ -
  • $header_plain
    • +
  • $header_plain
    • """ - - # HTML rendered for doc.item's seeSrc variable. Note that this will render to # the empty string if you don't pass anything through --git.url. Available # substitutaion variables here are: @@ -94,32 +92,31 @@ doc.item.tocTable = """ # * $line: line of the item in the original source file. # * $url: whatever you did pass through the --git.url switch (which also # gets variables path/line replaced!) -doc.item.seesrc = """  Source -  Edit +doc.item.seesrc = """ +Source   +Edit   """ doc.deprecationmsg = """ -
    - $label $message -
    +
    + $label $message +
    """ doc.toc = """ """ doc.body_toc_groupsection = """ -
    - Group by: - -
    +
    + Group by: + +
    """ @if boot: @@ -130,36 +127,36 @@ doc.body_toc_groupsection = """ doc.body_toc_group = """
    -
    - -     Dark Mode +
    + +     Dark Mode +
    + +
    + Search: +
    + $body_toc_groupsection +
    + $tableofcontents
    - -
    - Search: -
    - $body_toc_groupsection - $tableofcontents -
    - $seeSrc
    -
    - $deprecationMsg -

    $moduledesc

    - $content + $seeSrc + $deprecationMsg +

    $moduledesc

    + $content
    """ @@ -169,39 +166,36 @@ doc.body_toc_group = """ doc.body_toc_group = """
    -
    - -     Dark Mode +
    + +     Dark Mode +
    + +
    + Search: +
    +
    + Group by: + +
    +
    + $tableofcontents
    - -
    - Search: -
    -
    - Group by: - -
    - $tableofcontents -
    - $seeSrc
    -
    - $deprecationMsg -

    $moduledesc

    - $content + $seeSrc + $deprecationMsg +

    $moduledesc

    + $content
    """ @@ -220,14 +214,13 @@ doc.listing_end = "" # * $analytics: Google analytics location, includes - -
    -
    -

    $title

    $subtitle - $content -
    +
    +
    +

    $title

    $subtitle + $content
    -
    +
    Made with Nim. Generated: $date $time UTC
    -
    -$analytics + $analytics """ diff --git a/doc/nimdoc.css b/doc/nimdoc.css index 0014cf196..e72c4a213 100644 --- a/doc/nimdoc.css +++ b/doc/nimdoc.css @@ -159,24 +159,28 @@ body { padding: 0; box-sizing: border-box; } -.column, -.columns { +.column, .columns { width: 100%; float: left; box-sizing: border-box; - margin-left: 1%; -} + margin-left: 1%; } -.column:first-child, -.columns:first-child { +.column:first-child, .columns:first-child { margin-left: 0; } +.container .row { + display: flex; } + .three.columns { - width: 22%; -} + width: 25.0%; + height: 100vh; + position: sticky; + top: 0px; + overflow-y: auto; } .nine.columns { - width: 77.0%; } + width: 75.0%; + padding-left: 1.5em; } .twelve.columns { width: 100%; @@ -269,25 +273,26 @@ a.nimdoc { a.toc-backref { text-decoration: none; - color: var(--text); } + color: var(--text); +} a.link-seesrc { color: #607c9f; font-size: 0.9em; - font-style: italic; } + font-style: italic; +} -a:hover, -a:focus { +a:hover, a:focus { color: var(--anchor-focus); - text-decoration: underline; } + text-decoration: underline; +} a:hover span.Identifier { color: var(--anchor); } -sub, -sup { +sub, sup { position: relative; font-size: 75%; line-height: 0; @@ -314,8 +319,7 @@ img { background: transparent !important; box-shadow: none !important; } - a, - a:visited { + a, a:visited { text-decoration: underline; } a[href]:after { @@ -329,16 +333,14 @@ img { a[href^="#"]:after { content: ""; } - pre, - blockquote { + pre, blockquote { border: 1px solid #999; page-break-inside: avoid; } thead { display: table-header-group; } - tr, - img { + tr, img { page-break-inside: avoid; } img { @@ -353,22 +355,18 @@ img { h1.title { page-break-before: avoid; } - p, - h2, - h3 { + p, h2, h3 { orphans: 3; widows: 3; } - h2, - h3 { + h2, h3 { page-break-after: avoid; } } p { margin-top: 0.5em; - margin-bottom: 0.5em; -} + margin-bottom: 0.5em; } small { font-size: 85%; } @@ -376,8 +374,7 @@ small { strong { font-weight: 600; font-size: 0.95em; - color: var(--strong); -} + color: var(--strong); } em { font-style: italic; } @@ -398,8 +395,7 @@ h1.title { text-align: center; font-weight: 900; margin-top: 0.75em; - margin-bottom: 0em; -} + margin-bottom: 0em; } h2 { font-size: 1.3em; @@ -426,36 +422,29 @@ h6 { font-size: 1.1em; } -ul, -ol { +ul, ol { padding: 0; margin-top: 0.5em; margin-left: 0.75em; } -ul ul, -ul ol, -ol ol, -ol ul { +ul ul, ul ol, ol ol, ol ul { margin-bottom: 0; margin-left: 1.25em; } ul.simple > li { - list-style-type: circle; -} + list-style-type: circle; } ul.simple-boot li { - list-style-type: none; - margin-left: 0em; - margin-bottom: 0.5em; -} + list-style-type: none; + margin-left: 0em; + margin-bottom: 0.5em; } ol.simple > li, ul.simple > li { margin-bottom: 0.2em; margin-left: 0.4em } ul.simple.simple-toc > li { - margin-top: 1em; -} + margin-top: 1em; } ul.simple-toc { list-style: none; @@ -464,8 +453,7 @@ ul.simple-toc { margin-top: 1em; } ul.simple-toc > li { - list-style-type: none; -} + list-style-type: none; } ul.simple-toc-section { list-style-type: circle; @@ -475,12 +463,10 @@ ul.simple-toc-section { ul.nested-toc-section { list-style-type: circle; margin-left: -0.75em; - color: var(--text); -} + color: var(--text); } ul.nested-toc-section > li { - margin-left: 1.25em; -} + margin-left: 1.25em; } ol.arabic { @@ -527,7 +513,8 @@ hr.footnote { margin-top: 0.15em; } div.footnote-group { - margin-left: 1em; } + margin-left: 1em; +} div.footnote-label { display: inline-block; min-width: 1.7em; @@ -611,7 +598,7 @@ pre { border: 1px solid var(--border); -webkit-border-radius: 6px; -moz-border-radius: 6px; - border-radius: 6px; + border-radius: 6px; } .copyToClipBoardBtn { @@ -629,7 +616,7 @@ pre { .copyToClipBoard:hover .copyToClipBoardBtn { visibility: visible; -} +} .pre-scrollable { max-height: 340px; @@ -694,8 +681,8 @@ table th { font-weight: bold; } table th.docinfo-name { - background-color: transparent; - text-align: right; + background-color: transparent; + text-align: right; } table tr:hover { @@ -712,31 +699,31 @@ table.borderless td, table.borderless th { padding: 0 0.5em 0 0 !important; } .admonition { - padding: 0.3em; - background-color: var(--secondary-background); - border-left: 0.4em solid #7f7f84; - margin-bottom: 0.5em; - -webkit-box-shadow: 0 5px 8px -6px rgba(0,0,0,.2); - -moz-box-shadow: 0 5px 8px -6px rgba(0,0,0,.2); - box-shadow: 0 5px 8px -6px rgba(0,0,0,.2); + padding: 0.3em; + background-color: var(--secondary-background); + border-left: 0.4em solid #7f7f84; + margin-bottom: 0.5em; + -webkit-box-shadow: 0 5px 8px -6px rgba(0,0,0,.2); + -moz-box-shadow: 0 5px 8px -6px rgba(0,0,0,.2); + box-shadow: 0 5px 8px -6px rgba(0,0,0,.2); } .admonition-info { - border-color: var(--info-background); + border-color: var(--info-background); } .admonition-info-text { - color: var(--info-background); + color: var(--info-background); } .admonition-warning { - border-color: var(--warning-background); + border-color: var(--warning-background); } .admonition-warning-text { - color: var(--warning-background); + color: var(--warning-background); } .admonition-error { - border-color: var(--error-background); + border-color: var(--error-background); } .admonition-error-text { - color: var(--error-background); + color: var(--error-background); } .first { @@ -770,8 +757,7 @@ div.footer, div.header { font-size: smaller; } div.footer { - padding-top: 5em; -} + padding-top: 5em; } div.line-block { display: block; @@ -790,17 +776,14 @@ div.search_results { background-color: var(--third-background); margin: 3em; padding: 1em; - border: 1px solid #4d4d4d; -} + border: 1px solid #4d4d4d; } div#global-links ul { margin-left: 0; - list-style-type: none; -} + list-style-type: none; } div#global-links > simple-boot { - margin-left: 3em; -} + margin-left: 3em; } hr.docutils { width: 75%; } @@ -980,8 +963,7 @@ span.Directive { span.option { font-weight: bold; font-family: "Source Code Pro", Monaco, Menlo, Consolas, "Courier New", monospace; - color: var(--option); -} + color: var(--option); } span.Prompt { font-weight: bold; @@ -997,11 +979,10 @@ span.program { text-decoration: underline; text-decoration-color: var(--hint); text-decoration-thickness: 0.05em; - text-underline-offset: 0.15em; -} + text-underline-offset: 0.15em; } -span.Command, span.Rule, span.Hyperlink, span.Label, span.Reference, -span.Other { +span.Command, span.Rule, span.Hyperlink, +span.Label, span.Reference, span.Other { color: var(--other); } /* Pop type, const, proc, and iterator defs in nim def blocks */ @@ -1039,17 +1020,14 @@ span.pragmadots { border-radius: 4px; margin: 0 2px; cursor: pointer; - font-size: 0.8em; -} + font-size: 0.8em; } span.pragmadots:hover { - background-color: var(--hint); -} + background-color: var(--hint); } + span.pragmawrap { - display: none; -} + display: none; } span.attachedType { display: none; - visibility: hidden; -} + visibility: hidden; } diff --git a/nimdoc/rst2html/expected/rst_examples.html b/nimdoc/rst2html/expected/rst_examples.html index 2b5218d9f..532917055 100644 --- a/nimdoc/rst2html/expected/rst_examples.html +++ b/nimdoc/rst2html/expected/rst_examples.html @@ -1,12 +1,11 @@ - + - + - +Not a Nim Manual @@ -17,45 +16,42 @@ -Not a Nim Manual + - -
    -
    -

    Not a Nim Manual

    -
    +
    +
    +

    Not a Nim Manual

    +
    -
    - -     Dark Mode -
    - -
    - Search: -
    -
    - Group by: - -
    -
    -
    -
    - -

    + + +

    Authors:Andreas Rumpf, Zahary Karadjov
    Authors:Andreas Rumpf, Zahary Karadjov
    Version:|nimversion|

    "Complexity" seems to be a lot like "energy": you can transfer it from the end-user to one/some of the other players, but the total amount seems to remain pretty much constant for a given task. -- Ran

    @@ -262,19 +257,17 @@ stmt = IND{>} stmt ^+ IND{=} DED # list of statements F2 without pipe

    not in table

    - +
    -
    -
    +
    Made with Nim. Generated: 1970-01-02 03:46:40 UTC
    -
    - + diff --git a/nimdoc/test_out_index_dot_html/expected/index.html b/nimdoc/test_out_index_dot_html/expected/index.html index c6a116bd6..0c0dc2268 100644 --- a/nimdoc/test_out_index_dot_html/expected/index.html +++ b/nimdoc/test_out_index_dot_html/expected/index.html @@ -1,12 +1,11 @@ - + - + - +nimdoc/test_out_index_dot_html/foo @@ -17,94 +16,89 @@ -nimdoc/test_out_index_dot_html/foo + - -
    -
    -

    nimdoc/test_out_index_dot_html/foo

    -
    +
    +
    +

    nimdoc/test_out_index_dot_html/foo

    +
    -
    - -     Dark Mode -
    - -
    - Search: -
    -
    - Group by: - -
    -
      -
    • - Procs -
        +
        + +     Dark Mode +
        + +
        + Search: +
        +
        + Group by: + +
        +
        + +
      +
    -
    -
    - -

    -
    -

    Procs

    -
    - -
    -
    -
    proc foo() {....raises: [], tags: [].}
    -
    - -I do foo - -
    + + +

    +
    +

    Procs

    +
    +
    +
    + 
    proc foo() {....raises: [], tags: [].}
    +
    + + I do foo + +
    -
    +
    +
    -
    -
    +
    Made with Nim. Generated: 1970-01-02 03:46:40 UTC
    - - + diff --git a/nimdoc/test_out_index_dot_html/expected/theindex.html b/nimdoc/test_out_index_dot_html/expected/theindex.html index 8ee62a330..00c81189e 100644 --- a/nimdoc/test_out_index_dot_html/expected/theindex.html +++ b/nimdoc/test_out_index_dot_html/expected/theindex.html @@ -1,12 +1,11 @@ - + - + - +Index @@ -17,31 +16,28 @@ -Index + - -
    -
    -

    Index

    - Modules: index.

    API symbols

    +
    +
    +

    Index

    + Modules: index.

    API symbols

    foo:
    -
    -
    +
    Made with Nim. Generated: 1970-01-02 03:46:40 UTC
    -
    - + diff --git a/nimdoc/testproject/expected/nimdoc.out.css b/nimdoc/testproject/expected/nimdoc.out.css index 0014cf196..e72c4a213 100644 --- a/nimdoc/testproject/expected/nimdoc.out.css +++ b/nimdoc/testproject/expected/nimdoc.out.css @@ -159,24 +159,28 @@ body { padding: 0; box-sizing: border-box; } -.column, -.columns { +.column, .columns { width: 100%; float: left; box-sizing: border-box; - margin-left: 1%; -} + margin-left: 1%; } -.column:first-child, -.columns:first-child { +.column:first-child, .columns:first-child { margin-left: 0; } +.container .row { + display: flex; } + .three.columns { - width: 22%; -} + width: 25.0%; + height: 100vh; + position: sticky; + top: 0px; + overflow-y: auto; } .nine.columns { - width: 77.0%; } + width: 75.0%; + padding-left: 1.5em; } .twelve.columns { width: 100%; @@ -269,25 +273,26 @@ a.nimdoc { a.toc-backref { text-decoration: none; - color: var(--text); } + color: var(--text); +} a.link-seesrc { color: #607c9f; font-size: 0.9em; - font-style: italic; } + font-style: italic; +} -a:hover, -a:focus { +a:hover, a:focus { color: var(--anchor-focus); - text-decoration: underline; } + text-decoration: underline; +} a:hover span.Identifier { color: var(--anchor); } -sub, -sup { +sub, sup { position: relative; font-size: 75%; line-height: 0; @@ -314,8 +319,7 @@ img { background: transparent !important; box-shadow: none !important; } - a, - a:visited { + a, a:visited { text-decoration: underline; } a[href]:after { @@ -329,16 +333,14 @@ img { a[href^="#"]:after { content: ""; } - pre, - blockquote { + pre, blockquote { border: 1px solid #999; page-break-inside: avoid; } thead { display: table-header-group; } - tr, - img { + tr, img { page-break-inside: avoid; } img { @@ -353,22 +355,18 @@ img { h1.title { page-break-before: avoid; } - p, - h2, - h3 { + p, h2, h3 { orphans: 3; widows: 3; } - h2, - h3 { + h2, h3 { page-break-after: avoid; } } p { margin-top: 0.5em; - margin-bottom: 0.5em; -} + margin-bottom: 0.5em; } small { font-size: 85%; } @@ -376,8 +374,7 @@ small { strong { font-weight: 600; font-size: 0.95em; - color: var(--strong); -} + color: var(--strong); } em { font-style: italic; } @@ -398,8 +395,7 @@ h1.title { text-align: center; font-weight: 900; margin-top: 0.75em; - margin-bottom: 0em; -} + margin-bottom: 0em; } h2 { font-size: 1.3em; @@ -426,36 +422,29 @@ h6 { font-size: 1.1em; } -ul, -ol { +ul, ol { padding: 0; margin-top: 0.5em; margin-left: 0.75em; } -ul ul, -ul ol, -ol ol, -ol ul { +ul ul, ul ol, ol ol, ol ul { margin-bottom: 0; margin-left: 1.25em; } ul.simple > li { - list-style-type: circle; -} + list-style-type: circle; } ul.simple-boot li { - list-style-type: none; - margin-left: 0em; - margin-bottom: 0.5em; -} + list-style-type: none; + margin-left: 0em; + margin-bottom: 0.5em; } ol.simple > li, ul.simple > li { margin-bottom: 0.2em; margin-left: 0.4em } ul.simple.simple-toc > li { - margin-top: 1em; -} + margin-top: 1em; } ul.simple-toc { list-style: none; @@ -464,8 +453,7 @@ ul.simple-toc { margin-top: 1em; } ul.simple-toc > li { - list-style-type: none; -} + list-style-type: none; } ul.simple-toc-section { list-style-type: circle; @@ -475,12 +463,10 @@ ul.simple-toc-section { ul.nested-toc-section { list-style-type: circle; margin-left: -0.75em; - color: var(--text); -} + color: var(--text); } ul.nested-toc-section > li { - margin-left: 1.25em; -} + margin-left: 1.25em; } ol.arabic { @@ -527,7 +513,8 @@ hr.footnote { margin-top: 0.15em; } div.footnote-group { - margin-left: 1em; } + margin-left: 1em; +} div.footnote-label { display: inline-block; min-width: 1.7em; @@ -611,7 +598,7 @@ pre { border: 1px solid var(--border); -webkit-border-radius: 6px; -moz-border-radius: 6px; - border-radius: 6px; + border-radius: 6px; } .copyToClipBoardBtn { @@ -629,7 +616,7 @@ pre { .copyToClipBoard:hover .copyToClipBoardBtn { visibility: visible; -} +} .pre-scrollable { max-height: 340px; @@ -694,8 +681,8 @@ table th { font-weight: bold; } table th.docinfo-name { - background-color: transparent; - text-align: right; + background-color: transparent; + text-align: right; } table tr:hover { @@ -712,31 +699,31 @@ table.borderless td, table.borderless th { padding: 0 0.5em 0 0 !important; } .admonition { - padding: 0.3em; - background-color: var(--secondary-background); - border-left: 0.4em solid #7f7f84; - margin-bottom: 0.5em; - -webkit-box-shadow: 0 5px 8px -6px rgba(0,0,0,.2); - -moz-box-shadow: 0 5px 8px -6px rgba(0,0,0,.2); - box-shadow: 0 5px 8px -6px rgba(0,0,0,.2); + padding: 0.3em; + background-color: var(--secondary-background); + border-left: 0.4em solid #7f7f84; + margin-bottom: 0.5em; + -webkit-box-shadow: 0 5px 8px -6px rgba(0,0,0,.2); + -moz-box-shadow: 0 5px 8px -6px rgba(0,0,0,.2); + box-shadow: 0 5px 8px -6px rgba(0,0,0,.2); } .admonition-info { - border-color: var(--info-background); + border-color: var(--info-background); } .admonition-info-text { - color: var(--info-background); + color: var(--info-background); } .admonition-warning { - border-color: var(--warning-background); + border-color: var(--warning-background); } .admonition-warning-text { - color: var(--warning-background); + color: var(--warning-background); } .admonition-error { - border-color: var(--error-background); + border-color: var(--error-background); } .admonition-error-text { - color: var(--error-background); + color: var(--error-background); } .first { @@ -770,8 +757,7 @@ div.footer, div.header { font-size: smaller; } div.footer { - padding-top: 5em; -} + padding-top: 5em; } div.line-block { display: block; @@ -790,17 +776,14 @@ div.search_results { background-color: var(--third-background); margin: 3em; padding: 1em; - border: 1px solid #4d4d4d; -} + border: 1px solid #4d4d4d; } div#global-links ul { margin-left: 0; - list-style-type: none; -} + list-style-type: none; } div#global-links > simple-boot { - margin-left: 3em; -} + margin-left: 3em; } hr.docutils { width: 75%; } @@ -980,8 +963,7 @@ span.Directive { span.option { font-weight: bold; font-family: "Source Code Pro", Monaco, Menlo, Consolas, "Courier New", monospace; - color: var(--option); -} + color: var(--option); } span.Prompt { font-weight: bold; @@ -997,11 +979,10 @@ span.program { text-decoration: underline; text-decoration-color: var(--hint); text-decoration-thickness: 0.05em; - text-underline-offset: 0.15em; -} + text-underline-offset: 0.15em; } -span.Command, span.Rule, span.Hyperlink, span.Label, span.Reference, -span.Other { +span.Command, span.Rule, span.Hyperlink, +span.Label, span.Reference, span.Other { color: var(--other); } /* Pop type, const, proc, and iterator defs in nim def blocks */ @@ -1039,17 +1020,14 @@ span.pragmadots { border-radius: 4px; margin: 0 2px; cursor: pointer; - font-size: 0.8em; -} + font-size: 0.8em; } span.pragmadots:hover { - background-color: var(--hint); -} + background-color: var(--hint); } + span.pragmawrap { - display: none; -} + display: none; } span.attachedType { display: none; - visibility: hidden; -} + visibility: hidden; } diff --git a/nimdoc/testproject/expected/subdir/subdir_b/utils.html b/nimdoc/testproject/expected/subdir/subdir_b/utils.html index f94da7f40..d5a3b84c7 100644 --- a/nimdoc/testproject/expected/subdir/subdir_b/utils.html +++ b/nimdoc/testproject/expected/subdir/subdir_b/utils.html @@ -1,12 +1,11 @@ - + - + - +subdir/subdir_b/utils @@ -17,215 +16,189 @@ -subdir/subdir_b/utils + - -
    -
    -

    subdir/subdir_b/utils

    -
    +
    +
    +

    subdir/subdir_b/utils

    +
    -
    - -     Dark Mode -
    - -
    - Search: -
    -
    - Group by: - -
    - +
  • - Templates - + +
    • -
    -
    - -

    This is a description of the utils module.

    + + +

    This is a description of the utils module.

    Links work:

    • other module: iterators (not in this dir, just an example)
    • internal: fn2(x)
      • @@ -256,377 +229,356 @@

      Ref. type like G and type G and G[T] and type G*[T].

      Group ref. with capital letters works: fN11 or fn11

      Ref. [] is the same as proc `[]`(G[T]) because there are no overloads. The full form: proc `[]`*[T](x: G[T]): TRef. []= aka `[]=`(G[T], int, T).Ref. $ aka proc $ or proc `$`.Ref. $(a: ref SomeType).Ref. foo_bar aka iterator foo_bar_.Ref. fn[T; U,V: SomeFloat]().Ref. 'big or func `'big` or `'big`(string).

      -
      -

      Types

      -
      -
      -
      G[T] = object
+    
      
+  
      Types
      
+  
      
+    
      
+  
      G[T] = object
   val: T
 
      
-
      
-
-
-
-
      
+  
      
+    
+    
+    
+  
      
 
      
 
      
-
      SomeType = enum
+  
      SomeType = enum
   enumValueA, enumValueB, enumValueC
      
-
      
-
-
-
-
      
+  
      
+    
+    
+    
+  
      
 
      
 
-
      
+
      +
      -

      Procs

      -
      - -
      -
      -
      proc `$`[T](a: G[T]): string
      -
      - - - -
      +

      Procs

      +
      +
      +
      + 
      proc `$`[T](a: G[T]): string
      +
      + + + +
      -
      proc `$`[T](a: ref SomeType): string
      -
      - - - -
      + 
      proc `$`[T](a: ref SomeType): string
      +
      + + + +
      -
      -
      -
      func `'big`(a: string): SomeType {....raises: [], tags: [].}
      -
      - - - -
      +
      + 
      func `'big`(a: string): SomeType {....raises: [], tags: [].}
      +
      + + + +
      -
      -
      -
      proc `[]`[T](x: G[T]): T
      -
      - - - -
      +
      + 
      proc `[]`[T](x: G[T]): T
      +
      + + + +
      -
      -
      -
      proc `[]=`[T](a: var G[T]; index: int; value: T)
      -
      - - - -
      +
      + 
      proc `[]=`[T](a: var G[T]; index: int; value: T)
      +
      + + + +
      -
      -
      -
      proc binarySearch[T, K](a: openArray[T]; key: K;
+  
      
+  
      proc binarySearch[T, K](a: openArray[T]; key: K;
                         cmp: proc (x: T; y: K): int {.closure.}): int
      
-
      
-
-
-
-
      
+  
      
+    
+    
+    
+
      -
      -
      -
      proc f(x: G[int]) {....raises: [], tags: [].}
      -
      - -There is also variant f(G[string]) - -
      +
      + 
      proc f(x: G[int]) {....raises: [], tags: [].}
      +
      + + There is also variant f(G[string]) + +
      -
      proc f(x: G[string]) {....raises: [], tags: [].}
      -
      - -See also f(G[int]). - -
      + 
      proc f(x: G[string]) {....raises: [], tags: [].}
      +
      + + See also f(G[int]). + +
      -
      -
      -
      proc fn[T; U, V: SomeFloat]()
      -
      - - - -
      +
      + 
      proc fn[T; U, V: SomeFloat]()
      +
      + + + +
      -
      -
      -
      proc fn2() {....raises: [], tags: [].}
      -
      - -comment - -
      +
      + 
      proc fn2() {....raises: [], tags: [].}
      +
      + + comment + +
      -
      proc fn2(x: int) {....raises: [], tags: [].}
      -
      - -fn2 comment - -
      + 
      proc fn2(x: int) {....raises: [], tags: [].}
      +
      + + fn2 comment + +
      -
      proc fn2(x: int; y: float) {....raises: [], tags: [].}
      -
      - - - -
      + 
      proc fn2(x: int; y: float) {....raises: [], tags: [].}
      +
      + + + +
      -
      -
      -
      proc fn3(): auto {....raises: [], tags: [].}
      -
      - -comment - -
      +
      + 
      proc fn3(): auto {....raises: [], tags: [].}
      +
      + + comment + +
      -
      -
      -
      proc fn4(): auto {....raises: [], tags: [].}
      -
      - -comment - -
      +
      + 
      proc fn4(): auto {....raises: [], tags: [].}
      +
      + + comment + +
      -
      -
      -
      proc fn5() {....raises: [], tags: [].}
      -
      - -comment - -
      +
      + 
      proc fn5() {....raises: [], tags: [].}
      +
      + + comment + +
      -
      -
      -
      proc fn6() {....raises: [], tags: [].}
      -
      - -comment - -
      +
      + 
      proc fn6() {....raises: [], tags: [].}
      +
      + + comment + +
      -
      -
      -
      proc fn7() {....raises: [], tags: [].}
      -
      - -comment - -
      +
      + 
      proc fn7() {....raises: [], tags: [].}
      +
      + + comment + +
      -
      -
      -
      proc fn8(): auto {....raises: [], tags: [].}
      -
      - -comment - -
      +
      + 
      proc fn8(): auto {....raises: [], tags: [].}
      +
      + + comment + +
      -
      -
      -
      func fn9(a: int): int {....raises: [], tags: [].}
      -
      - -comment - -
      +
      + 
      func fn9(a: int): int {....raises: [], tags: [].}
      +
      + + comment + +
      -
      -
      -
      func fn10(a: int): int {....raises: [], tags: [].}
      -
      - -comment - -
      +
      + 
      func fn10(a: int): int {....raises: [], tags: [].}
      +
      + + comment + +
      -
      -
      -
      func fN11() {....raises: [], tags: [].}
      -
      - - - -
      +
      + 
      func fN11() {....raises: [], tags: [].}
      +
      + + + +
      -
      func fN11(x: int) {....raises: [], tags: [].}
      -
      - - - -
      + 
      func fN11(x: int) {....raises: [], tags: [].}
      +
      + + + +
      -
      -
      -
      proc funWithGenerics[T, U: SomeFloat](a: T; b: U)
      -
      - - - -
      +
      + 
      proc funWithGenerics[T, U: SomeFloat](a: T; b: U)
      +
      + + + +
      -
      -
      -
      proc someType(): SomeType {....raises: [], tags: [].}
      -
      - -constructor. - -
      +
      + 
      proc someType(): SomeType {....raises: [], tags: [].}
      +
      + + constructor. + +
      -
      +
      +
      -

      Iterators

      -
      - -
      -
      -
      iterator fooBar(a: seq[SomeType]): int {....raises: [], tags: [].}
      -
      - - - -
      +

      Iterators

      +
      +
      +
      + 
      iterator fooBar(a: seq[SomeType]): int {....raises: [], tags: [].}
      +
      + + + +
      -
      +
      +
      -

      Templates

      -
      - -
      -
      -
      template aEnum(): untyped
      -
      - - - -
      +

      Templates

      +
      +
      +
      + 
      template aEnum(): untyped
      +
      + + + +
      -
      -
      -
      template bEnum(): untyped
      -
      - - - -
      +
      + 
      template bEnum(): untyped
      +
      + + + +
      -
      -
      -
      template fromUtilsGen(): untyped
      -
      - -should be shown in utils.html only +
      + 
      template fromUtilsGen(): untyped
      +
      + + should be shown in utils.html only

      Example:

      discard "should be in utils.html only, not in module that calls fromUtilsGen"
      ditto - -
      + +
      -
      +
      +
    -
    -
    +
    Made with Nim. Generated: 1970-01-02 03:46:40 UTC
    -
    - + diff --git a/nimdoc/testproject/expected/testproject.html b/nimdoc/testproject/expected/testproject.html index cba9391af..49f24d204 100644 --- a/nimdoc/testproject/expected/testproject.html +++ b/nimdoc/testproject/expected/testproject.html @@ -1,12 +1,11 @@ - + - + - +testproject @@ -17,372 +16,327 @@ -testproject + - -
    -
    -

    testproject

    -
    +
    +
    +

    testproject

    +
    -
    - -     Dark Mode -
    - -
    - Search: -
    -
    - Group by: - -
    - +
  • - Methods - + +
  • - Iterators - + +
  • - Macros - + +
  • - Templates - + +
    • -
    -
    - -

    This is the top level module. + + +

    This is the top level module.

    Example:

    import testproject
 import subdir / subdir_b / utils
@@ -396,133 +350,136 @@
 
    Example:
    
 
    import testproject
 discard "in top3"
    top3 after
    
-  
+    
 
    
-
    Types
    
-
    
-
    
-
    A {.inject.} = enum
+  
    Types
    
+  
    
+    
    
+  
    A {.inject.} = enum
   aA
    
-
    
-
-The enum A.
-
-
    
+  
    
+    
+    The enum A.
+    
+  
    
 
    
 
    
-
    B {.inject.} = enum
+  
    B {.inject.} = enum
   bB
    
-
    
-
-The enum B.
-
-
    
+  
    
+    
+    The enum B.
+    
+  
    
 
    
 
    
-
    Foo = enum
+  
    Foo = enum
   enumValueA2
    
-
    
-
-
-
-
    
+  
    
+    
+    
+    
+  
    
 
    
 
    
-
    FooBuzz {....deprecated: "FooBuzz msg".} = int
    
-
    
-  
    
-    Deprecated: FooBuzz msg
-  
    
+  
    FooBuzz {....deprecated: "FooBuzz msg".} = int
    
+  
    
+    
    
+  Deprecated: FooBuzz msg
+
    
 
-
-
-
    
+    
+    
+  
 
    
 
    
-
    Shapes = enum
+  
    Shapes = enum
   Circle,                   ## A circle
   Triangle,                 ## A three-sided shape
   Rectangle                  ## A four-sided shape
    
-
    
-
-Some shapes.
-
-
    
+  
    
+    
+    Some shapes.
+    
+  
    
 
    
 
-
    
+  
    
+
    
 
    
-
    Vars
    
-
    
-
    
-
    aVariable: array[1, int]
    
-
    
-
-
-
-
    
+  
    Vars
    
+  
    
+    
    
+  
    aVariable: array[1, int]
    
+  
    
+    
+    
+    
+  
    
 
    
 
    
-
    someVariable: bool
    
-
    
-
-This should be visible.
-
-
    
+  
    someVariable: bool
    
+  
    
+    
+    This should be visible.
+    
+  
    
 
    
 
-
    
+  
    
+
    
 
    
-
    Consts
    
-
    
-
    
-
    C_A = 0x7FF0000000000000'f64
    
-
    
-
-
-
-
    
+  
    Consts
    
+  
    
+    
    
+  
    C_A = 0x7FF0000000000000'f64
    
+  
    
+    
+    
+    
+  
    
 
    
 
    
-
    C_B = 0o377'i8
    
-
    
-
-
-
-
    
+  
    C_B = 0o377'i8
    
+  
    
+    
+    
+    
+  
    
 
    
 
    
-
    C_C = 0o277'i8
    
-
    
-
-
-
-
    
+  
    C_C = 0o277'i8
    
+  
    
+    
+    
+    
+  
    
 
    
 
    
-
    C_D = 0o177777'i16
    
-
    
-
-
-
-
    
+  
    C_D = 0o177777'i16
    
+  
    
+    
+    
+    
+  
    
 
    
 
-
    
+  
    
+
    
 
    
-
    Procs
    
-
    
-
-
    
-
    
-
    proc addfBug14485() {....raises: [], tags: [].}
    
-
    
-
-Some proc
+  
    Procs
    
+  
    
+    
    
+  
    
+  
    proc addfBug14485() {....raises: [], tags: [].}
    
+  
    
+    
+    Some proc
 
    Example:
    
 
    discard "foo() = " & $[1]
 #[
@@ -535,208 +492,194 @@ Some proc
 6: </script
 7: end of broken html
 ]#
    
-
-
    
+    
+  
    
 
    
 
 
    
-
 
    
-
    
-
    proc anything() {....raises: [], tags: [].}
    
-
    
-
-There is no block quote after blank lines at the beginning.
-
-
    
+  
    
+  
    proc anything() {....raises: [], tags: [].}
    
+  
    
+    
+    There is no block quote after blank lines at the beginning.
+    
+  
    
 
    
 
 
    
-
 
    
-
    
-
    proc asyncFun1(): Future[int] {....raises: [Exception, ValueError],
+  
    
+  
    proc asyncFun1(): Future[int] {....raises: [Exception, ValueError],
                                 tags: [RootEffect].}
    
-
    
-
-ok1
-
-
    
+  
    
+    
+    ok1
+    
+  
    
 
    
 
 
    
-
 
    
-
    
-
    proc asyncFun2(): owned(Future[void]) {....raises: [Exception], tags: [RootEffect].}
    
-
    
-
-
-
-
    
+  
    
+  
    proc asyncFun2(): owned(Future[void]) {....raises: [Exception], tags: [RootEffect].}
    
+  
    
+    
+    
+    
+  
    
 
    
 
 
    
-
 
    
-
    
-
    proc asyncFun3(): owned(Future[void]) {....raises: [Exception], tags: [RootEffect].}
    
-
    
-
-
+  
    
+  
    proc asyncFun3(): owned(Future[void]) {....raises: [Exception], tags: [RootEffect].}
    
+  
    
+    
+    
 
    Example:
    
 
    discard
    ok1
-
-
    
+    
+  
 
    
 
 
    
-
 
    
-
    
-
    proc bar[T](a, b: T): T
    
-
    
-
-
-
-
    
+  
    
+  
    proc bar[T](a, b: T): T
    
+  
    
+    
+    
+    
+  
    
 
    
 
 
    
-
 
    
-
    
-
    proc baz() {....raises: [], tags: [].}
    
-
    
-
-
-
-
    
+  
    
+  
    proc baz() {....raises: [], tags: [].}
    
+  
    
+    
+    
+    
+  
    
 
    
 
    
-
    proc baz[T](a, b: T): T {....deprecated.}
    
-
    
-  
    
-    Deprecated 
-  
    
+  
    proc baz[T](a, b: T): T {....deprecated.}
    
+  
    
+    
    
+  Deprecated 
+
    
 
-This is deprecated without message.
-
-
    
+    This is deprecated without message.
+    
+  
 
    
 
 
    
-
 
    
-
    
-
    proc buzz[T](a, b: T): T {....deprecated: "since v0.20".}
    
-
    
-  
    
-    Deprecated: since v0.20
-  
    
+  
    
+  
    proc buzz[T](a, b: T): T {....deprecated: "since v0.20".}
    
+  
    
+    
    
+  Deprecated: since v0.20
+
    
 
-This is deprecated with a message.
-
-
    
+    This is deprecated with a message.
+    
+  
 
    
 
 
    
-
 
    
-
    
-
    proc c_nonexistent(frmt: cstring): cint {.importc: "nonexistent",
+  
    
+  
    proc c_nonexistent(frmt: cstring): cint {.importc: "nonexistent",
     header: "<stdio.h>", varargs, discardable, ...raises: [], tags: [].}
    
-
    
-
-
-
-
    
+  
    
+    
+    
+    
+  
    
 
    
 
 
    
-
 
    
-
    
-
    proc c_printf(frmt: cstring): cint {.importc: "printf", header: "<stdio.h>",
+  
    
+  
    proc c_printf(frmt: cstring): cint {.importc: "printf", header: "<stdio.h>",
                                      varargs, discardable, ...raises: [], tags: [].}
    
-
    
-
-the c printf. etc.
-
-
    
+  
    
+    
+    the c printf. etc.
+    
+  
    
 
    
 
 
    
-
 
    
-
    
-
    proc fromUtils3() {....raises: [], tags: [].}
    
-
    
-
-came form utils but should be shown where fromUtilsGen is called
+  
    
+  
    proc fromUtils3() {....raises: [], tags: [].}
    
+  
    
+    
+    came form utils but should be shown where fromUtilsGen is called
 
    Example:
    
 
    discard """should be shown as examples for fromUtils3
        in module calling fromUtilsGen"""
    
-
-
    
+    
+  
 
    
 
 
    
-
 
    
-
    
-
    proc isValid[T](x: T): bool
    
-
    
-
-
-
-
    
+  
    
+  
    proc isValid[T](x: T): bool
    
+  
    
+    
+    
+    
+  
    
 
    
 
 
    
-
 
    
-
    
-
    proc low[T: Ordinal | enum | range](x: T): T {.magic: "Low", noSideEffect,
+  
    
+  
    proc low[T: Ordinal | enum | range](x: T): T {.magic: "Low", noSideEffect,
     ...raises: [], tags: [].}
    
-
    
-
-
    Returns the lowest possible value of an ordinal value x. As a special semantic rule, x may also be a type identifier.
    
+  
    
+    
+    
    Returns the lowest possible value of an ordinal value x. As a special semantic rule, x may also be a type identifier.
    
 
    See also:
    
 
 
    low(2) # => -9223372036854775808
    
-
-
    
+    
+  
 
    
 
 
    
-
 
    
-
    
-
    proc low2[T: Ordinal | enum | range](x: T): T {.magic: "Low", noSideEffect,
+  
    
+  
    proc low2[T: Ordinal | enum | range](x: T): T {.magic: "Low", noSideEffect,
     ...raises: [], tags: [].}
    
-
    
-
-
    Returns the lowest possible value of an ordinal value x. As a special semantic rule, x may also be a type identifier.
    
+  
    
+    
+    
    Returns the lowest possible value of an ordinal value x. As a special semantic rule, x may also be a type identifier.
    
 
    See also:
    
 
 
    low2(2) # => -9223372036854775808
    
 
    Example:
    
 
    discard "in low2"
    
-
-
    
+    
+  
 
    
 
 
    
-
 
    
-
    
-
    proc p1() {....raises: [], tags: [].}
    
-
    
-
-cp1
+  
    
+  
    proc p1() {....raises: [], tags: [].}
    
+  
    
+    
+    cp1
 
    Example:
    
 
    doAssert 1 == 1 # regular comments work here
    c4
 
    Example:
    
@@ -753,30 +696,28 @@ this is a nested doc comment
 ]##
 discard "c9"
 # also work after
    - - + +
    -
    -
    -
    func someFunc() {....raises: [], tags: [].}
    -
    - -My someFunc. Stuff in quotes here. Some link - -
    +
    + 
    func someFunc() {....raises: [], tags: [].}
    +
    + + My someFunc. Stuff in quotes here. Some link + +
    -
    -
    -
    proc tripleStrLitTest() {....raises: [], tags: [].}
    -
    - - +
    + 
    proc tripleStrLitTest() {....raises: [], tags: [].}
    +
    + +

    Example: cmd: --hint:XDeclaredButNotUsed:off

    ## mullitline string litterals are tricky as their indentation can span
 ## below that of the runnableExamples
@@ -813,365 +754,343 @@ at indent 0
   """ ]
 discard
 # should be in
    - -
    + +
    -
    -
    -
    proc z1(): Foo {....raises: [], tags: [].}
    -
    - -cz1 - -
    +
    + 
    proc z1(): Foo {....raises: [], tags: [].}
    +
    + + cz1 + +
    -
    -
    -
    proc z2() {....raises: [], tags: [].}
    -
    - -cz2 +
    + 
    proc z2() {....raises: [], tags: [].}
    +
    + + cz2

    Example:

    discard "in cz2"
    - -
    + +
    -
    -
    -
    proc z3() {....raises: [], tags: [].}
    -
    - -cz3 - -
    +
    + 
    proc z3() {....raises: [], tags: [].}
    +
    + + cz3 + +
    -
    -
    -
    proc z4() {....raises: [], tags: [].}
    -
    - -cz4 - -
    +
    + 
    proc z4() {....raises: [], tags: [].}
    +
    + + cz4 + +
    -
    -
    -
    proc z5(): int {....raises: [], tags: [].}
    -
    - -cz5 - -
    +
    + 
    proc z5(): int {....raises: [], tags: [].}
    +
    + + cz5 + +
    -
    -
    -
    proc z6(): int {....raises: [], tags: [].}
    -
    - -cz6 - -
    +
    + 
    proc z6(): int {....raises: [], tags: [].}
    +
    + + cz6 + +
    -
    -
    -
    proc z7(): int {....raises: [], tags: [].}
    -
    - -cz7 - -
    +
    + 
    proc z7(): int {....raises: [], tags: [].}
    +
    + + cz7 + +
    -
    -
    -
    proc z8(): int {....raises: [], tags: [].}
    -
    - -cz8 - -
    +
    + 
    proc z8(): int {....raises: [], tags: [].}
    +
    + + cz8 + +
    -
    -
    -
    proc z9() {....raises: [], tags: [].}
    -
    - - +
    + 
    proc z9() {....raises: [], tags: [].}
    +
    + +

    Example:

    doAssert 1 + 1 == 2
    - -
    + +
    -
    -
    -
    proc z10() {....raises: [], tags: [].}
    -
    - - +
    + 
    proc z10() {....raises: [], tags: [].}
    +
    + +

    Example: cmd: -d:foobar

    discard 1
    cz10 - -
    + +
    -
    -
    -
    proc z11() {....raises: [], tags: [].}
    -
    - - +
    + 
    proc z11() {....raises: [], tags: [].}
    +
    + +

    Example:

    discard 1
    - -
    + +
    -
    -
    -
    proc z12(): int {....raises: [], tags: [].}
    -
    - - +
    + 
    proc z12(): int {....raises: [], tags: [].}
    +
    + +

    Example:

    discard 1
    - -
    + +
    -
    -
    -
    proc z13() {....raises: [], tags: [].}
    -
    - -cz13 +
    + 
    proc z13() {....raises: [], tags: [].}
    +
    + + cz13

    Example:

    discard
    - -
    + +
    -
    -
    -
    proc z17() {....raises: [], tags: [].}
    -
    - -cz17 rest +
    + 
    proc z17() {....raises: [], tags: [].}
    +
    + + cz17 rest

    Example:

    discard 1
    rest - -
    + +
    -
    + +
    -

    Methods

    -
    - -
    -
    -
    method method1(self: Moo) {.base, ...raises: [], tags: [].}
    -
    - -foo1 - -
    +

    Methods

    +
    +
    +
    + 
    method method1(self: Moo) {.base, ...raises: [], tags: [].}
    +
    + + foo1 + +
    -
    -
    -
    method method2(self: Moo): int {.base, ...raises: [], tags: [].}
    -
    - -foo2 - -
    +
    + 
    method method2(self: Moo): int {.base, ...raises: [], tags: [].}
    +
    + + foo2 + +
    -
    -
    -
    method method3(self: Moo): int {.base, ...raises: [], tags: [].}
    -
    - -foo3 - -
    +
    + 
    method method3(self: Moo): int {.base, ...raises: [], tags: [].}
    +
    + + foo3 + +
    -
    +
    +
    -

    Iterators

    -
    - -
    -
    -
    iterator fromUtils1(): int {....raises: [], tags: [].}
    -
    - - +

    Iterators

    +
    +
    +
    + 
    iterator fromUtils1(): int {....raises: [], tags: [].}
    +
    + +

    Example:

    # ok1
 assert 1 == 1
 # ok2
    - -
    + +
    -
    -
    -
    iterator iter1(n: int): int {....raises: [], tags: [].}
    -
    - -foo1 - -
    +
    + 
    iterator iter1(n: int): int {....raises: [], tags: [].}
    +
    + + foo1 + +
    -
    -
    -
    iterator iter2(n: int): int {....raises: [], tags: [].}
    -
    - -foo2 +
    + 
    iterator iter2(n: int): int {....raises: [], tags: [].}
    +
    + + foo2

    Example:

    discard # bar
    - -
    + +
    -
    + +
    -

    Macros

    -
    - -
    -
    -
    macro bar(): untyped
    -
    - - - -
    +

    Macros

    +
    +
    +
    + 
    macro bar(): untyped
    +
    + + + +
    -
    -
    -
    macro z16()
    -
    - - +
    + 
    macro z16()
    +
    + +

    Example:

    discard 1
    cz16 after

    Example:

    doAssert 2 == 1 + 1
    - -
    + +
    -
    -
    -
    macro z18(): int
    -
    - -cz18 - -
    +
    + 
    macro z18(): int
    +
    + + cz18 + +
    -
    +
    +
    -

    Templates

    -
    - -
    -
    -
    template foo(a, b: SomeType)
    -
    - -This does nothing - -
    +

    Templates

    +
    +
    +
    + 
    template foo(a, b: SomeType)
    +
    + + This does nothing + +
    -
    -
    -
    template fromUtils2()
    -
    - -ok3 +
    + 
    template fromUtils2()
    +
    + + ok3

    Example:

    discard """should be shown as examples for fromUtils2
        in module calling fromUtilsGen"""
    - -
    + +
    -
    -
    -
    template myfn()
    -
    - - +
    + 
    template myfn()
    +
    + +

    Example:

    import std/strutils
 ## issue #8871 preserve formatting
@@ -1187,58 +1106,54 @@ bar
 block:
   discard 0xff # elu par cette crapule
 # should be in
    should be still in - -
    + +
    -
    -
    -
    template testNimDocTrailingExample()
    -
    - - +
    + 
    template testNimDocTrailingExample()
    +
    + +

    Example:

    discard 2
    - -
    + +
    -
    -
    -
    template z6t(): int
    -
    - -cz6t - -
    +
    + 
    template z6t(): int
    +
    + + cz6t + +
    -
    -
    -
    template z14()
    -
    - -cz14 +
    + 
    template z14()
    +
    + + cz14

    Example:

    discard
    - -
    + +
    -
    -
    -
    template z15()
    -
    - -cz15 +
    + 
    template z15()
    +
    + + cz15

    Example:

    discard

    Example:

    @@ -1249,26 +1164,25 @@ cz15 
    assert true

    Example:

    discard 1
    in or out? - -
    + +
    -
    +
    +
    -
    -
    +
    Made with Nim. Generated: 1970-01-02 03:46:40 UTC
    -
    - + diff --git a/nimdoc/testproject/expected/theindex.html b/nimdoc/testproject/expected/theindex.html index 47fae2491..c62b4c7db 100644 --- a/nimdoc/testproject/expected/theindex.html +++ b/nimdoc/testproject/expected/theindex.html @@ -1,12 +1,11 @@ - + - + - +Index @@ -17,17 +16,16 @@ -Index + - -
    -
    -

    Index

    - Modules: subdir/subdir_b/utils, testproject.

    API symbols

    +
    +
    +

    Index

    + Modules: subdir/subdir_b/utils, testproject.

    API symbols

    `$`:
    -
    -
    +
    Made with Nim. Generated: 1970-01-02 03:46:40 UTC
    -
    - +