-
-
Notifications
You must be signed in to change notification settings - Fork 36
/
nimdoc.cfg
163 lines (149 loc) · 5.26 KB
/
nimdoc.cfg
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
# This is the config file for the documentation generator.
# (c) 2012 Andreas Rumpf
# Feel free to edit the templates as you need. If you modify this file, it
# might be worth updating the hardcoded values in packages/docutils/rstgen.nim
split.item.toc = "20"
# too long entries in the table of contents wrap around
# after this number of characters
doc.section = """
<section id="$sectionID">
<h1><a class="toc-backref" href="#$sectionID">$sectionTitle</a></h1>
<dl class="item">
$content
</dl></section>
"""
doc.section.toc = """
<li>
<a class="reference reference-toplevel" href="#$sectionID" id="$sectionTitleID">$sectionTitle</a>
<ul class="simple simple-toc-section">
$content
</ul>
</li>
"""
# Chunk of HTML emitted for each entry in the HTML table of contents.
# 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.
# * $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.
# * $itemSymOrID: the symbolic name or the ID if that is not unique.
# * $itemSymOrIDEnc: quoted version for URLs or attributes.
# * $name: reduced name of the item.
# * $seeSrc: generated HTML from doc.item.seesrc (if some switches are used).
doc.item = """
<dt id="$itemSym"><a name="$itemSymOrID"></a><pre>$header</pre></dt>
<dd>
$desc
$seeSrc
</dd>
"""
# Chunk of HTML emitted for each entry in the HTML table of contents.
# See doc.item for available substitution variables.
doc.item.toc = """
<li><a class="reference" href="#$itemSymOrIDEnc"
title="$header_plain">$name</a></li>
"""
# HTML rendered for doc.item's seeSrc variable. Note that this will render to
# the empty string if you don't pass anything through --docSeeSrcURL. Available
# substitutaion variables here are:
# * $path: relative path to the file being processed.
# * $line: line of the item in the original source file.
# * $url: whatever you did pass through the --docSeeSrcUrl switch (which also
# gets variables path/line replaced!)
doc.item.seesrc = """ <a
href="${url}/${path}#L${line}"
class="link-seesrc" target="_blank">Source</a>"""
doc.toc = """
<ul class="simple simple-toc" id="toc-list">
$content
</ul>
"""
doc.body_toc = """
<div class="row">
<div class="three columns">
$tableofcontents
</div>
<div class="nine columns" id="content">
<p class="module-desc">$moduledesc</p>
$content
</div>
</div>
"""
doc.body_no_toc = """
$moduledesc
$content
"""
doc.listing_start = "<pre class = \"listing\">"
doc.listing_end = "</pre>"
doc.file = """
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>NimYAML - $title</title>
<link href="/docutils.css" rel="stylesheet" type="text/css"/>
<link href="/style.css" rel="stylesheet" type="text/css"/>
<link href='http://fonts.googleapis.com/css?family=Raleway:400,600,900' rel='stylesheet' type='text/css'/>
<link href='http://fonts.googleapis.com/css?family=Source+Code+Pro:400,500,600' rel='stylesheet' type='text/css'/>
</head>
<body>
<header>
<a class="pagetitle" href="/index.html">NimYAML</a></span>
<span><a href="/index.html">Home</a></span>
<span><a href="/testing.html">Testing Ground</a></span>
<span>Docs:</span>
<a href="/api.html">Overview</a>
<span>
<a href="/serialization.html">Serialization</a>
<ul>
<li><a href="/serialization.html">Overview</a></li>
<li><a href="/schema.html">Schema</a></li>
</ul>
</span>
<span>
<a href="/api/yaml.html">Modules</a>
<ul class="monospace">
<li><a href="/api/yaml.html">yaml</a></li>
<li><a href="/api/yaml/annotations.html">yaml/annotations</a></li>
<li><a href="/api/yaml/data.html">yaml/data</a></li>
<li><a href="/api/yaml/dom.html">yaml/dom</a></li>
<li><a href="/api/yaml/dumping.html">yaml/dumping</a></li>
<li><a href="/api/yaml/hints.html">yaml/hints</a></li>
<li><a href="/api/yaml/loading.html">yaml/loading</a></li>
<li><a href="/api/yaml/native.html">yaml/native</a></li>
<li><a href="/api/yaml/parser.html">yaml/parser</a></li>
<li><a href="/api/yaml/presenter.html">yaml/presenter</a></li>
<li><a href="/api/yaml/stream.html">yaml/stream</a></li>
<li><a href="/api/yaml/style.html">yaml/style</a></li>
<li><a href="/api/yaml/taglib.html">yaml/taglib</a></li>
<li><a href="/api/yaml/tojson.html">yaml/tojson</a></li>
</ul>
</span>
<span>
<a href="/migrating.html">NimYAML 2.x</a>
</span>
<span class="space"></span>
<span>
<a href="https://github.com/flyx/NimYAML">
<img src="/github-mark-white.svg" style="width: 1.5em; height: 1.5em; margin-bottom: -.2em; padding-right: .2em; margin-top: -.5em;" /> Source on GitHub
</a>
</span>
</header>
<article id="documentId">
<div class="container">
<h1 class="title">$title</h1>
$content
<div class="row">
<div class="twelve-columns footer">
<span class="nim-sprite"></span>
<br/>
<small>Made with Nim.</small>
</div>
</div>
</div>
</article>
</body>
</html>
"""