build based on 0dbe2a3

latest/outputformats.html

@@ -17,4 +17,4 @@ Here is an example with some code
 ```@example
 x = sin.(cos.([1, 2, 3]))
 y = x.^2 - x
-```</code></pre><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="Examples.markdown" href="#Examples.markdown"><code>Examples.markdown</code></a> — <span class="docstring-category">Function</span>.</div><div><div><pre><code class="language-none">Examples.markdown(inputfile, outputdir; kwargs...)</code></pre><p>Generate a markdown file from <code>inputfile</code> and write the result to the directory<code>outputdir</code>.</p><p>Keyword arguments:</p><ul><li><code>name</code>: name of the output file, excluding <code>.md</code>. <code>name</code> is also used to name all the <code>@example</code> blocks. Defaults to the filename of <code>inputfile</code>.</li><li><code>preprocess</code>, <code>postprocess</code>: custom pre- and post-processing functions, see the <a href="customprocessing.html#Custom-pre-and-post-processing-1">Custom pre- and post-processing</a> section of the manual. Defaults to <code>identity</code>.</li><li><code>documenter</code>: boolean that tells if the output is intended to use with Documenter.jl. Defaults to <code>true</code>. See the the manual section on <a href="documenter.html#Interaction-with-Documenter-1">Interaction with Documenter</a>.</li><li><code>codefence</code>: A <code>Pair</code> of opening and closing code fence. Defaults to<pre><code class="language-none">&quot;```@example $(name)&quot; =&gt; &quot;```&quot;</code></pre>if <code>documenter = true</code> and<pre><code class="language-none">&quot;```julia&quot; =&gt; &quot;```&quot;</code></pre>if <code>documenter = false</code>.</li></ul></div></div><a class="source-link" target="_blank" href="https://github.com/fredrikekre/Examples.jl/blob/3e47aac5307ed828b52d3547dad53b5c304107ca/src/Examples.jl#L160-L184">source</a></section><h2><a class="nav-anchor" id="Notebook-output-1" href="#Notebook-output-1"><strong>4.2.</strong> Notebook output</a></h2><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="Examples.notebook" href="#Examples.notebook"><code>Examples.notebook</code></a> — <span class="docstring-category">Function</span>.</div><div><div><pre><code class="language-none">Examples.notebook(inputfile, outputdir; kwargs...)</code></pre><p>Generate a notebook from <code>inputfile</code> and write the result to <code>outputdir</code>.</p><p>Keyword arguments:</p><ul><li><code>name</code>: name of the output file, excluding <code>.ipynb</code>. Defaults to the filename of <code>inputfile</code>.</li><li><code>preprocess</code>, <code>postprocess</code>: custom pre- and post-processing functions, see the <a href="customprocessing.html#Custom-pre-and-post-processing-1">Custom pre- and post-processing</a> section of the manual. Defaults to <code>identity</code>.</li><li><code>execute</code>: a boolean deciding if the generated notebook should also be executed or not. Defaults to <code>true</code>.</li><li><code>documenter</code>: boolean that says if the source contains Documenter.jl specific things to filter out during notebook generation. Defaults to <code>true</code>. See the the manual section on <a href="documenter.html#Interaction-with-Documenter-1">Interaction with Documenter</a>.</li></ul></div></div><a class="source-link" target="_blank" href="https://github.com/fredrikekre/Examples.jl/blob/3e47aac5307ed828b52d3547dad53b5c304107ca/src/Examples.jl#L272-L288">source</a></section><h2><a class="nav-anchor" id="Script-output-1" href="#Script-output-1"><strong>4.3.</strong> Script output</a></h2><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="Examples.script" href="#Examples.script"><code>Examples.script</code></a> — <span class="docstring-category">Function</span>.</div><div><div><pre><code class="language-none">Examples.script(inputfile, outputdir; kwargs...)</code></pre><p>Generate a plain script file from <code>inputfile</code> and write the result to <code>outputdir</code>.</p><p>Keyword arguments:</p><ul><li><code>name</code>: name of the output file, excluding <code>.jl</code>. Defaults to the filename of <code>inputfile</code>.</li><li><code>preprocess</code>, <code>postprocess</code>: custom pre- and post-processing functions, see the <a href="customprocessing.html#Custom-pre-and-post-processing-1">Custom pre- and post-processing</a> section of the manual. Defaults to <code>identity</code>.</li></ul></div></div><a class="source-link" target="_blank" href="https://github.com/fredrikekre/Examples.jl/blob/3e47aac5307ed828b52d3547dad53b5c304107ca/src/Examples.jl#L93-L104">source</a></section><footer><hr/><a class="previous" href="pipeline.html"><span class="direction">Previous</span><span class="title"><strong>3.</strong> Processing pipeline</span></a><a class="next" href="customprocessing.html"><span class="direction">Next</span><span class="title"><strong>5.</strong> Custom pre- and post-processing</span></a></footer></article></body></html>
+```</code></pre><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="Examples.markdown" href="#Examples.markdown"><code>Examples.markdown</code></a> — <span class="docstring-category">Function</span>.</div><div><div><pre><code class="language-none">Examples.markdown(inputfile, outputdir; kwargs...)</code></pre><p>Generate a markdown file from <code>inputfile</code> and write the result to the directory<code>outputdir</code>.</p><p>Keyword arguments:</p><ul><li><code>name</code>: name of the output file, excluding <code>.md</code>. <code>name</code> is also used to name all the <code>@example</code> blocks. Defaults to the filename of <code>inputfile</code>.</li><li><code>preprocess</code>, <code>postprocess</code>: custom pre- and post-processing functions, see the <a href="customprocessing.html#Custom-pre-and-post-processing-1">Custom pre- and post-processing</a> section of the manual. Defaults to <code>identity</code>.</li><li><code>documenter</code>: boolean that tells if the output is intended to use with Documenter.jl. Defaults to <code>true</code>. See the the manual section on <a href="documenter.html#Interaction-with-Documenter-1">Interaction with Documenter</a>.</li><li><code>codefence</code>: A <code>Pair</code> of opening and closing code fence. Defaults to<pre><code class="language-none">&quot;```@example $(name)&quot; =&gt; &quot;```&quot;</code></pre>if <code>documenter = true</code> and<pre><code class="language-none">&quot;```julia&quot; =&gt; &quot;```&quot;</code></pre>if <code>documenter = false</code>.</li></ul></div></div><a class="source-link" target="_blank" href="https://github.com/fredrikekre/Examples.jl/blob/0dbe2a37299a63edb95b27fc16ccd95e66a2c9e6/src/Examples.jl#L160-L184">source</a></section><h2><a class="nav-anchor" id="Notebook-output-1" href="#Notebook-output-1"><strong>4.2.</strong> Notebook output</a></h2><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="Examples.notebook" href="#Examples.notebook"><code>Examples.notebook</code></a> — <span class="docstring-category">Function</span>.</div><div><div><pre><code class="language-none">Examples.notebook(inputfile, outputdir; kwargs...)</code></pre><p>Generate a notebook from <code>inputfile</code> and write the result to <code>outputdir</code>.</p><p>Keyword arguments:</p><ul><li><code>name</code>: name of the output file, excluding <code>.ipynb</code>. Defaults to the filename of <code>inputfile</code>.</li><li><code>preprocess</code>, <code>postprocess</code>: custom pre- and post-processing functions, see the <a href="customprocessing.html#Custom-pre-and-post-processing-1">Custom pre- and post-processing</a> section of the manual. Defaults to <code>identity</code>.</li><li><code>execute</code>: a boolean deciding if the generated notebook should also be executed or not. Defaults to <code>true</code>.</li><li><code>documenter</code>: boolean that says if the source contains Documenter.jl specific things to filter out during notebook generation. Defaults to <code>true</code>. See the the manual section on <a href="documenter.html#Interaction-with-Documenter-1">Interaction with Documenter</a>.</li></ul></div></div><a class="source-link" target="_blank" href="https://github.com/fredrikekre/Examples.jl/blob/0dbe2a37299a63edb95b27fc16ccd95e66a2c9e6/src/Examples.jl#L272-L288">source</a></section><h2><a class="nav-anchor" id="Script-output-1" href="#Script-output-1"><strong>4.3.</strong> Script output</a></h2><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="Examples.script" href="#Examples.script"><code>Examples.script</code></a> — <span class="docstring-category">Function</span>.</div><div><div><pre><code class="language-none">Examples.script(inputfile, outputdir; kwargs...)</code></pre><p>Generate a plain script file from <code>inputfile</code> and write the result to <code>outputdir</code>.</p><p>Keyword arguments:</p><ul><li><code>name</code>: name of the output file, excluding <code>.jl</code>. Defaults to the filename of <code>inputfile</code>.</li><li><code>preprocess</code>, <code>postprocess</code>: custom pre- and post-processing functions, see the <a href="customprocessing.html#Custom-pre-and-post-processing-1">Custom pre- and post-processing</a> section of the manual. Defaults to <code>identity</code>.</li></ul></div></div><a class="source-link" target="_blank" href="https://github.com/fredrikekre/Examples.jl/blob/0dbe2a37299a63edb95b27fc16ccd95e66a2c9e6/src/Examples.jl#L93-L104">source</a></section><footer><hr/><a class="previous" href="pipeline.html"><span class="direction">Previous</span><span class="title"><strong>3.</strong> Processing pipeline</span></a><a class="next" href="customprocessing.html"><span class="direction">Next</span><span class="title"><strong>5.</strong> Custom pre- and post-processing</span></a></footer></article></body></html>