You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<headerclass="odoc-preamble"><h1>Module <code><span>Wodoc.Nav</span></code></h1><p>Build a manual's left-column navigation from its wikicréole menu.</p><p>The OCaml port of the per-project <code>gen-manual-nav.py</code> scripts: one implementation, the per-project differences (page location, API landing map, heading) given as options.</p></header>
149
-
<divclass="odoc-content"><divclass="odoc-spec"><divclass="spec value anchored" id="val-manual"><code><span><spanclass="keyword">val</span> manual :
string</span></code></div><divclass="spec-doc"><p><code>manual ~base menu</code> renders the <code><nav></code> for the wiki menu source <code>menu</code>.</p><ul><li><code>pkg</code> (default <code>""</code>): package dir holding the manual pages; <code>""</code> puts a <code>[page|T]</code> link at <code><base>/<page>.html</code>, otherwise <code><base>/<pkg>/<page>.html</code>.</li><li><code>heading</code> (default <code>"Manual"</code>): the <code><h3></code> label.</li><li><code>api_map</code> (default <code>[]</code>): subproject -> path (relative to <code>base</code>) for <code><<a_api>></code> landings; an unknown subproject falls back to <code><subproject>/index.html</code>.</li></ul></div></div><divclass="odoc-spec"><divclass="spec value anchored" id="val-api"><code><span><spanclass="keyword">val</span> api :
150
+
<headerclass="odoc-preamble"><h1>Module <code><span>Wodoc.Nav</span></code></h1><p>Build a project's API module navigation from a curated odoc index.</p><p>The manual's own left navigation is no longer generated from a wikicréole menu: it is described declaratively in the project's <code>doc/wodoc</code> config (the <code>(nav …)</code> stanza) and rendered by <ahref="../Build/index.html"><code>Build</code></a>. This module only renders the API module list, from a curated odoc <code>.indexdoc</code>.</p></header>
151
+
<divclass="odoc-content"><divclass="odoc-spec"><divclass="spec value anchored" id="val-api"><code><span><spanclass="keyword">val</span> api :
string</span></code></div><divclass="spec-doc"><p><code>api ~base ~lib indexdoc</code> renders the API module <code><nav></code> from a curated odoc index (<code>{N title}</code> sections + <code>{!modules: …}</code> lists). The OCaml port of <code>gen-nav.py</code>. A module path <code>A.B.C</code> maps to <code><base>/<lib>/[<wrapper>/]A/B/C/index.html</code>. <code>skip</code> lists section titles to drop (page titles, <code>Index</code>); <code>heading</code> is the <code><h3></code> (default <code>"Modules"</code>).</p></div></div><divclass="odoc-spec"><divclass="spec value anchored" id="val-anchors"><code><span><spanclass="keyword">val</span> anchors : <span><spanclass="optlabel">?heading</span>:string <spanclass="arrow">-></span></span><span><spanclass="label">base</span>:string <spanclass="arrow">-></span></span><span>string <spanclass="arrow">-></span></span> string</span></code></div><divclass="spec-doc"><p><code>anchors ~base menu</code> renders a single-page manual's <code><nav></code> from a wiki menu of in-page anchor links <code>[[#anchor|Title]]</code> (-> <code><base>/index.html#anchor</code>), cleaning <code>{{{…}}}</code>/<code>##…##</code> markup from titles. The OCaml port of <code>gen-anchor-nav.py</code>.</p></div></div></div>
158
+
string</span></code></div><divclass="spec-doc"><p><code>api ~base ~lib indexdoc</code> renders the API module <code><nav></code> from a curated odoc index (<code>{N title}</code> sections + <code>{!modules: …}</code> lists). The OCaml port of <code>gen-nav.py</code>. A module path <code>A.B.C</code> maps to <code><base>/<lib>/[<wrapper>/]A/B/C/index.html</code>. <code>skip</code> lists section titles to drop (page titles, <code>Index</code>); <code>heading</code> is the <code><h3></code> (default <code>"Modules"</code>).</p></div></div></div>
0 commit comments