mirror of
https://github.com/nim-lang/Nim.git
synced 2026-01-16 09:37:12 +00:00
304 lines
26 KiB
HTML
304 lines
26 KiB
HTML
<?xml version="1.0" encoding="utf-8" ?>
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<!-- This file is generated by Nim. -->
|
|
<html xmlns="https://www.w3.org/1999/xhtml" xml:lang="en" lang="en" data-theme="auto">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<title>packages/docutils/rstidx</title>
|
|
|
|
<!-- Google fonts -->
|
|
<link href='https://fonts.googleapis.com/css?family=Lato:400,600,900' rel='stylesheet' type='text/css'/>
|
|
<link href='https://fonts.googleapis.com/css?family=Source+Code+Pro:400,500,600' rel='stylesheet' type='text/css'/>
|
|
|
|
<!-- Favicon -->
|
|
<link rel="shortcut icon" href="data:image/x-icon;base64,AAABAAEAEBAAAAEAIABoBAAAFgAAACgAAAAQAAAAIAAAAAEAIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAUAAAAF////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAIAAABbAAAAlQAAAKIAAACbAAAAmwAAAKIAAACVAAAAWwAAAAL///8A////AP///wD///8A////AAAAABQAAADAAAAAYwAAAA3///8A////AP///wD///8AAAAADQAAAGMAAADAAAAAFP///wD///8A////AP///wAAAACdAAAAOv///wD///8A////AP///wD///8A////AP///wD///8AAAAAOgAAAJ3///8A////AP///wAAAAAnAAAAcP///wAAAAAoAAAASv///wD///8A////AP///wAAAABKAAAAKP///wAAAABwAAAAJ////wD///8AAAAAgQAAABwAAACIAAAAkAAAAJMAAACtAAAAFQAAABUAAACtAAAAkwAAAJAAAACIAAAAHAAAAIH///8A////AAAAAKQAAACrAAAAaP///wD///8AAAAARQAAANIAAADSAAAARf///wD///8AAAAAaAAAAKsAAACk////AAAAADMAAACcAAAAnQAAABj///8A////AP///wAAAAAYAAAAGP///wD///8A////AAAAABgAAACdAAAAnAAAADMAAAB1AAAAwwAAAP8AAADpAAAAsQAAAE4AAAAb////AP///wAAAAAbAAAATgAAALEAAADpAAAA/wAAAMMAAAB1AAAAtwAAAOkAAAD/AAAA/wAAAP8AAADvAAAA3gAAAN4AAADeAAAA3gAAAO8AAAD/AAAA/wAAAP8AAADpAAAAtwAAAGUAAAA/AAAA3wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAADfAAAAPwAAAGX///8A////AAAAAEgAAADtAAAAvwAAAL0AAADGAAAA7wAAAO8AAADGAAAAvQAAAL8AAADtAAAASP///wD///8A////AP///wD///8AAAAAO////wD///8A////AAAAAIcAAACH////AP///wD///8AAAAAO////wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A//8AAP//AAD4HwAA7/cAAN/7AAD//wAAoYUAAJ55AACf+QAAh+EAAAAAAADAAwAA4AcAAP5/AAD//wAA//8AAA=="/>
|
|
<link rel="icon" type="image/png" sizes="32x32" href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAA3XAAAN1wFCKJt4AAAAB3RJTUUH4QQQEwksSS9ZWwAAAk1JREFUWMPtll2ITVEUx39nn/O7Y5qR8f05wtCUUr6ZIS++8pEnkZInPImneaCQ5METNdOkeFBKUhMPRIkHKfEuUZSUlGlKPN2TrgfncpvmnntnmlEyq1Z7t89/rf9a6+y99oZxGZf/XeIq61EdtgKXgdXA0xrYAvBjOIF1AI9zvjcC74BSpndrJPkBWDScTF8Aa4E3wDlgHbASaANmVqlcCnwHvgDvgVfAJ+AikAAvgfVZwLnSVZHZaOuKoQi3ZOMi4NkYkpe1p4J7A8BpYAD49hfIy/oqG0+hLomiKP2L5L+1ubn5115S+3OAn4EnwBlgMzCjyt6ZAnQCJ4A7wOs88iRJHvw50HoujuPBoCKwHWiosy8MdfZnAdcHk8dxXFJ3VQbQlCTJvRBCGdRbD4M6uc5glpY3eAihpN5S5w12diSEcCCEcKUO4ljdr15T76ur1FDDLIQQ3qv71EdDOe3Kxj3leRXyk+pxdWnFWod6Wt2bY3de3aSuUHcPBVimHs7mK9WrmeOF6lR1o9qnzskh2ar2qm1qizpfXaPeVGdlmGN5pb09qMxz1Xb1kLqgzn1RyH7JUXW52lr5e/Kqi9qpto7V1atuUzfnARrV7jEib1T76gG2qxdGmXyiekkt1GswPTtek0aBfJp6YySGBfWg2tPQ0FAYgf1stUfdmdcjarbYJEniKIq6gY/Aw+zWHAC+p2labGpqiorFYgGYCEzN7oQdQClN07O1/EfDyGgC0ALMBdYAi4FyK+4H3gLPsxfR1zRNi+NP7nH5J+QntnXe5B5mpfQAAAAASUVORK5CYII=">
|
|
|
|
<!-- CSS -->
|
|
<link rel="stylesheet" type="text/css" href="nimdoc.out.css?v=2.3.1">
|
|
|
|
<!-- JS -->
|
|
<script type="text/javascript" src="dochack.js?v=2.3.1"></script>
|
|
</head>
|
|
<body>
|
|
<div class="document" id="documentId">
|
|
<div class="container">
|
|
<h1 class="title">packages/docutils/rstidx</h1>
|
|
<div class="row">
|
|
<div class="three columns">
|
|
<div class="theme-select-wrapper">
|
|
<label for="theme-select">Theme: </label>
|
|
<select id="theme-select" onchange="setTheme(this.value)">
|
|
<option value="auto">🌗 Match OS</option>
|
|
<option value="dark">🌑 Dark</option>
|
|
<option value="light">🌕 Light</option>
|
|
</select>
|
|
</div>
|
|
<div id="global-links">
|
|
<ul class="simple-boot">
|
|
<li><a href="manual.html">Manual</a></li>
|
|
<li><a href="lib.html">Standard library</a></li>
|
|
<li> <a id="indexLink" href="theindex.html">Index</a></li>
|
|
<li><a href="compiler/theindex.html">Compiler docs</a></li>
|
|
<li><a href="https://nim-lang.github.io/fusion/theindex.html">Fusion docs</a></li>
|
|
<li><a href="https://nim-lang.github.io/Nim/">devel</a>, <a href="https://nim-lang.org/documentation.html">stable</a></li>
|
|
</ul>
|
|
</div>
|
|
<div id="searchInputDiv">
|
|
Search: <input type="search" id="searchInput"
|
|
oninput="search()" />
|
|
</div>
|
|
|
|
<ul class="simple simple-toc" id="toc-list">
|
|
<li>
|
|
<a class="reference reference-toplevel" href="#6" id="56">Imports</a>
|
|
</li>
|
|
<li>
|
|
<details open>
|
|
<summary><a class="reference reference-toplevel" href="#7" id="57">Types</a></summary>
|
|
<ul class="simple simple-toc-section">
|
|
<li><a class="reference" href="#IndexEntry" title="IndexEntry = object
|
|
kind*: IndexEntryKind ## 0.
|
|
keyword*: string ## 1.
|
|
link*: string ## 2.
|
|
linkTitle*: string ## 3. contains a prettier text for the href
|
|
linkDesc*: string ## 4. the title attribute of the final href
|
|
line*: int ## 5.
|
|
module*: string ## origin file, NOT a field in ``.idx`` file
|
|
aux*: string ## auxuliary field, NOT a field in ``.idx`` file">IndexEntry</a></li>
|
|
<li><a class="reference" href="#IndexEntryKind" title="IndexEntryKind = enum
|
|
ieMarkupTitle = "markupTitle", ## RST/Markdown title, text in `keyword` +
|
|
## HTML text in `linkTitle`
|
|
ieNimTitle = "nimTitle", ## Nim title
|
|
ieHeading = "heading", ## RST/Markdown markup heading, escaped
|
|
ieIdxRole = "idx", ## RST :idx: definition, escaped
|
|
ieNim = "nim", ## Nim symbol, unescaped
|
|
ieNimGroup = "nimgrp" ## Nim overload group, unescaped">IndexEntryKind</a></li>
|
|
|
|
</ul>
|
|
</details>
|
|
</li>
|
|
<li>
|
|
<details open>
|
|
<summary><a class="reference reference-toplevel" href="#12" id="62">Procs</a></summary>
|
|
<ul class="simple simple-toc-section">
|
|
<ul class="simple nested-toc-section">$
|
|
<li><a class="reference" href="#%24%2CIndexEntry" title="`$`(e: IndexEntry): string">`$`(e: IndexEntry): string</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">cmp
|
|
<li><a class="reference" href="#cmp%2CIndexEntry%2CIndexEntry" title="cmp(a, b: IndexEntry): int">cmp(a, b: IndexEntry): int</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">formatIndexEntry
|
|
<li><a class="reference" href="#formatIndexEntry%2CIndexEntryKind%2Cstring%2Cstring%2Cstring%2Cstring%2Cstring%2Cint" title="formatIndexEntry(kind: IndexEntryKind;
|
|
htmlFile, id, term, linkTitle, linkDesc: string; line: int): tuple[
|
|
entry: string, isTitle: bool]">formatIndexEntry(kind: IndexEntryKind;
|
|
htmlFile, id, term, linkTitle, linkDesc: string; line: int): tuple[
|
|
entry: string, isTitle: bool]</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">hash
|
|
<li><a class="reference" href="#hash%2CIndexEntry" title="hash(x: IndexEntry): Hash">hash(x: IndexEntry): Hash</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">isDocumentationTitle
|
|
<li><a class="reference" href="#isDocumentationTitle%2Cstring" title="isDocumentationTitle(hyperlink: string): bool">isDocumentationTitle(hyperlink: string): bool</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">parseIdxFile
|
|
<li><a class="reference" href="#parseIdxFile%2Cstring" title="parseIdxFile(path: string): tuple[fileEntries: seq[IndexEntry],
|
|
title: IndexEntry]">parseIdxFile(path: string): tuple[fileEntries: seq[IndexEntry],
|
|
title: IndexEntry]</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">unquoteIndexColumn
|
|
<li><a class="reference" href="#unquoteIndexColumn%2Cstring" title="unquoteIndexColumn(text: string): string">unquoteIndexColumn(text: string): string</a></li>
|
|
|
|
</ul>
|
|
|
|
</ul>
|
|
</details>
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</div>
|
|
<div class="nine columns" id="content">
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/packages/docutils/rstidx.nim#L1" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/packages/docutils/rstidx.nim#L1" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
<div id="tocRoot"></div>
|
|
|
|
<p class="module-desc">Nim <span id="idx_1">idx</span> file format related definitions.</p>
|
|
<div class="section" id="6">
|
|
<h1><a class="toc-backref" href="#6">Imports</a></h1>
|
|
<dl class="item">
|
|
<a class="reference external" href="strutils.html">strutils</a>, <a class="reference external" href="syncio.html">syncio</a>, <a class="reference external" href="hashes.html">hashes</a>, <a class="reference external" href="os.html">os</a>
|
|
</dl>
|
|
</div>
|
|
<div class="section" id="7">
|
|
<h1><a class="toc-backref" href="#7">Types</a></h1>
|
|
<dl class="item">
|
|
<div id="IndexEntry">
|
|
<dt><pre><a href="rstidx.html#IndexEntry"><span class="Identifier">IndexEntry</span></a> <span class="Other">=</span> <span class="Keyword">object</span>
|
|
<span class="Identifier">kind</span><span class="Operator">*</span><span class="Other">:</span> <a href="rstidx.html#IndexEntryKind"><span class="Identifier">IndexEntryKind</span></a> <span class="Comment">## 0.</span>
|
|
<span class="Identifier">keyword</span><span class="Operator">*</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> <span class="Comment">## 1.</span>
|
|
<span class="Identifier">link</span><span class="Operator">*</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> <span class="Comment">## 2.</span>
|
|
<span class="Identifier">linkTitle</span><span class="Operator">*</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> <span class="Comment">## 3. contains a prettier text for the href</span>
|
|
<span class="Identifier">linkDesc</span><span class="Operator">*</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> <span class="Comment">## 4. the title attribute of the final href</span>
|
|
<span class="Identifier">line</span><span class="Operator">*</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> <span class="Comment">## 5.</span>
|
|
<span class="Identifier">module</span><span class="Operator">*</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> <span class="Comment">## origin file, NOT a field in ``.idx`` file</span>
|
|
<span class="Identifier">aux</span><span class="Operator">*</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> <span class="Comment">## auxuliary field, NOT a field in ``.idx`` file</span></pre></dt>
|
|
<dd>
|
|
|
|
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/packages/docutils/rstidx.nim#L24" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/packages/docutils/rstidx.nim#L24" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="IndexEntryKind">
|
|
<dt><pre><a href="rstidx.html#IndexEntryKind"><span class="Identifier">IndexEntryKind</span></a> <span class="Other">=</span> <span class="Keyword">enum</span>
|
|
<span class="Identifier">ieMarkupTitle</span> <span class="Other">=</span> <span class="StringLit">"markupTitle"</span><span class="Other">,</span> <span class="Comment">## RST/Markdown title, text in `keyword` +</span>
|
|
<span class="Comment">## HTML text in `linkTitle`</span>
|
|
<span class="Identifier">ieNimTitle</span> <span class="Other">=</span> <span class="StringLit">"nimTitle"</span><span class="Other">,</span> <span class="Comment">## Nim title</span>
|
|
<span class="Identifier">ieHeading</span> <span class="Other">=</span> <span class="StringLit">"heading"</span><span class="Other">,</span> <span class="Comment">## RST/Markdown markup heading, escaped</span>
|
|
<span class="Identifier">ieIdxRole</span> <span class="Other">=</span> <span class="StringLit">"idx"</span><span class="Other">,</span> <span class="Comment">## RST :idx: definition, escaped</span>
|
|
<span class="Identifier">ieNim</span> <span class="Other">=</span> <span class="StringLit">"nim"</span><span class="Other">,</span> <span class="Comment">## Nim symbol, unescaped</span>
|
|
<span class="Identifier">ieNimGroup</span> <span class="Other">=</span> <span class="StringLit">"nimgrp"</span> <span class="Comment">## Nim overload group, unescaped</span></pre></dt>
|
|
<dd>
|
|
|
|
discriminator tag
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/packages/docutils/rstidx.nim#L14" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/packages/docutils/rstidx.nim#L14" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</dl>
|
|
</div>
|
|
<div class="section" id="12">
|
|
<h1><a class="toc-backref" href="#12">Procs</a></h1>
|
|
<dl class="item">
|
|
<div id="$-procs-all">
|
|
<div id="$,IndexEntry">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#%24%2CIndexEntry"><span class="Identifier">`$`</span></a><span class="Other">(</span><span class="Identifier">e</span><span class="Other">:</span> <a href="rstidx.html#IndexEntry"><span class="Identifier">IndexEntry</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ValueError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/packages/docutils/rstidx.nim#L41" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/packages/docutils/rstidx.nim#L41" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="cmp-procs-all">
|
|
<div id="cmp,IndexEntry,IndexEntry">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#cmp%2CIndexEntry%2CIndexEntry"><span class="Identifier">cmp</span></a><span class="Other">(</span><span class="Identifier">a</span><span class="Other">,</span> <span class="Identifier">b</span><span class="Other">:</span> <a href="rstidx.html#IndexEntry"><span class="Identifier">IndexEntry</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
Sorts two <tt class="docutils literal"><span class="pre">IndexEntry</span></tt> first by <tt class="docutils literal"><span class="pre"><span class="Identifier">keyword</span></span></tt> field, then by <tt class="docutils literal"><span class="pre"><span class="Identifier">link</span></span></tt>.
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/packages/docutils/rstidx.nim#L128" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/packages/docutils/rstidx.nim#L128" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="formatIndexEntry-procs-all">
|
|
<div id="formatIndexEntry,IndexEntryKind,string,string,string,string,string,int">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#formatIndexEntry%2CIndexEntryKind%2Cstring%2Cstring%2Cstring%2Cstring%2Cstring%2Cint"><span class="Identifier">formatIndexEntry</span></a><span class="Other">(</span><span class="Identifier">kind</span><span class="Other">:</span> <a href="rstidx.html#IndexEntryKind"><span class="Identifier">IndexEntryKind</span></a><span class="Other">;</span>
|
|
<span class="Identifier">htmlFile</span><span class="Other">,</span> <span class="Identifier">id</span><span class="Other">,</span> <span class="Identifier">term</span><span class="Other">,</span> <span class="Identifier">linkTitle</span><span class="Other">,</span> <span class="Identifier">linkDesc</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">line</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">tuple</span><span class="Other">[</span>
|
|
<span class="Identifier">entry</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">,</span> <span class="Identifier">isTitle</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a><span class="Other">]</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/packages/docutils/rstidx.nim#L68" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/packages/docutils/rstidx.nim#L68" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="hash-procs-all">
|
|
<div id="hash,IndexEntry">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#hash%2CIndexEntry"><span class="Identifier">hash</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="rstidx.html#IndexEntry"><span class="Identifier">IndexEntry</span></a><span class="Other">)</span><span class="Other">:</span> <a href="hashes.html#Hash"><span class="Identifier">Hash</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
<p>Returns the hash for the combined fields of the type.</p>
|
|
<p>The hash is computed as the chained hash of the individual string hashes.</p>
|
|
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/packages/docutils/rstidx.nim#L134" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/packages/docutils/rstidx.nim#L134" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="isDocumentationTitle-procs-all">
|
|
<div id="isDocumentationTitle,string">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#isDocumentationTitle%2Cstring"><span class="Identifier">isDocumentationTitle</span></a><span class="Other">(</span><span class="Identifier">hyperlink</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
|
<span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
<p>Returns true if the hyperlink is actually a documentation title.</p>
|
|
<p>Documentation titles lack the hash. See <a class="reference external" href="#mergeIndexes,string">mergeIndexes()</a> for a more detailed explanation.</p>
|
|
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/packages/docutils/rstidx.nim#L34" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/packages/docutils/rstidx.nim#L34" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="parseIdxFile-procs-all">
|
|
<div id="parseIdxFile,string">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#parseIdxFile%2Cstring"><span class="Identifier">parseIdxFile</span></a><span class="Other">(</span><span class="Identifier">path</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">tuple</span><span class="Other">[</span><span class="Identifier">fileEntries</span><span class="Other">:</span> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><a href="rstidx.html#IndexEntry"><span class="Identifier">IndexEntry</span></a><span class="Other">]</span><span class="Other">,</span>
|
|
<span class="Identifier">title</span><span class="Other">:</span> <a href="rstidx.html#IndexEntry"><span class="Identifier">IndexEntry</span></a><span class="Other">]</span> {.
|
|
<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">ValueError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/packages/docutils/rstidx.nim#L97" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/packages/docutils/rstidx.nim#L97" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="unquoteIndexColumn-procs-all">
|
|
<div id="unquoteIndexColumn,string">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#unquoteIndexColumn%2Cstring"><span class="Identifier">unquoteIndexColumn</span></a><span class="Other">(</span><span class="Identifier">text</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
|
<span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
Returns the unquoted version generated by <tt class="docutils literal"><span class="pre">quoteIndexColumn</span></tt>.
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/packages/docutils/rstidx.nim#L64" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/packages/docutils/rstidx.nim#L64" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</dl>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="twelve-columns footer">
|
|
<span class="nim-sprite"></span>
|
|
<br>
|
|
<small style="color: var(--hint);">Made with Nim. Generated: 2026-01-14 15:37:08 UTC</small>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<script defer data-domain="nim-lang.org" src="https://plausible.io/js/plausible.js"></script>
|
|
|
|
</body>
|
|
</html>
|