diff options
Diffstat (limited to 'docs.html')
| -rw-r--r-- | docs.html | 15 |
1 files changed, 8 insertions, 7 deletions
@@ -100,9 +100,9 @@ function main() { <li> <a class="reference reference-toplevel" href="#12" id="62">Procs</a> <ul class="simple simple-toc-section"> - <li><a class="reference" href="#buildDocs%2CopenArray%5Bstring%5D%2Cstring%2CopenArray%5Bstring%5D" + <li><a class="reference" href="#buildDocs%2CopenArray%5Bstring%5D%2Cstring%2CopenArray%5Bstring%5D%2Cstring" title="buildDocs(files: openArray[string]; path: string; baseDir = getProjectPath() & "/"; - defines: openArray[string] = @[])"><wbr />build<wbr />Docs<span class="attachedType"></span></a></li> + defines: openArray[string] = @[]; nimArgs = "")"><wbr />build<wbr />Docs<span class="attachedType"></span></a></li> </ul> </li> @@ -117,15 +117,16 @@ function main() { <div class="section" id="12"> <h1><a class="toc-backref" href="#12">Procs</a></h1> <dl class="item"> -<a id="buildDocs,openArray[string],string,openArray[string]"></a> -<dt><pre><span class="Keyword">proc</span> <a href="#buildDocs%2CopenArray%5Bstring%5D%2Cstring%2CopenArray%5Bstring%5D"><span class="Identifier">buildDocs</span></a><span class="Other">(</span><span class="Identifier">files</span><span class="Other">:</span> <span class="Identifier">openArray</span><span class="Other">[</span><span class="Identifier">string</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">path</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">;</span> - <span class="Identifier">baseDir</span> <span class="Other">=</span> <span class="Identifier">getProjectPath</span><span class="Other">(</span><span class="Other">)</span> <span class="Operator">&</span> <span class="StringLit">"/"</span><span class="Other">;</span> <span class="Identifier">defines</span><span class="Other">:</span> <span class="Identifier">openArray</span><span class="Other">[</span><span class="Identifier">string</span><span class="Other">]</span> <span class="Other">=</span> <span class="Operator">@</span><span class="Other">[</span><span class="Other">]</span><span class="Other">)</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"> - <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">OSError</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><span class="Other">.}</span></span></pre></dt> +<a id="buildDocs,openArray[string],string,openArray[string],string"></a> +<dt><pre><span class="Keyword">proc</span> <a href="#buildDocs%2CopenArray%5Bstring%5D%2Cstring%2CopenArray%5Bstring%5D%2Cstring"><span class="Identifier">buildDocs</span></a><span class="Other">(</span><span class="Identifier">files</span><span class="Other">:</span> <span class="Identifier">openArray</span><span class="Other">[</span><span class="Identifier">string</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">path</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">;</span> + <span class="Identifier">baseDir</span> <span class="Other">=</span> <span class="Identifier">getProjectPath</span><span class="Other">(</span><span class="Other">)</span> <span class="Operator">&</span> <span class="StringLit">"/"</span><span class="Other">;</span> <span class="Identifier">defines</span><span class="Other">:</span> <span class="Identifier">openArray</span><span class="Other">[</span><span class="Identifier">string</span><span class="Other">]</span> <span class="Other">=</span> <span class="Operator">@</span><span class="Other">[</span><span class="Other">]</span><span class="Other">;</span> + <span class="Identifier">nimArgs</span> <span class="Other">=</span> <span class="StringLit">""</span><span class="Other">)</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">OSError</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><span class="Other">.}</span></span></pre></dt> <dd> <p>Generate docs for all specified nim <tt class="docutils literal"><span class="pre">files</span></tt> to the specified <tt class="docutils literal"><span class="pre">path</span></tt></p> <p><tt class="docutils literal"><span class="pre">baseDir</span></tt> is the project path by default and <tt class="docutils literal"><span class="pre">files</span></tt> and <tt class="docutils literal"><span class="pre">path</span></tt> are relative to that directory. Set to "" if using absolute paths.</p> <p><tt class="docutils literal"><span class="pre">defines</span></tt> is a list of <tt class="docutils literal"><span class="pre">-d:xxx</span></tt> define flags (the <tt class="docutils literal"><span class="pre">xxx</span></tt> part) that should be passed to <tt class="docutils literal"><span class="pre">nim doc</span></tt> so that <tt class="docutils literal"><span class="pre">getHeader()</span></tt> is invoked correctly.</p> +<p><tt class="docutils literal"><span class="pre">nimArgs</span></tt> is a string representing extra arguments to send to the <tt class="docutils literal"><span class="pre">nim doc</span></tt> call.</p> <p>Use the <tt class="docutils literal"><span class="pre">--publish</span></tt> flag with nimble to publish docs contained in <tt class="docutils literal"><span class="pre">path</span></tt> to Github in the <tt class="docutils literal"><span class="pre">gh-pages</span></tt> branch. This requires the ghp-import package for Python: <tt class="docutils literal"><span class="pre">pip install ghp-import</span></tt></p> <p>WARNING: <tt class="docutils literal"><span class="pre">--publish</span></tt> will destroy any existing content in this branch.</p> <p>NOTE: <tt class="docutils literal"><span class="pre">buildDocs()</span></tt> only works correctly on Windows with Nim 1.0+ since <a class="reference external" href="https://github.com/nim-lang/Nim/pull/11814">https://github.com/nim-lang/Nim/pull/11814</a> is required.</p> @@ -142,7 +143,7 @@ function main() { <div class="twelve-columns footer"> <span class="nim-sprite"></span> <br/> - <small style="color: var(--hint);">Made with Nim. Generated: 2020-04-28 21:50:48 UTC</small> + <small style="color: var(--hint);">Made with Nim. Generated: 2020-05-11 03:35:43 UTC</small> </div> </div> </div> |