<htmllang="en"><head><metacharset="UTF-8"/><metaname="viewport"content="width=device-width, initial-scale=1.0"/><title>7. Example · Examples.jl</title><linkhref="https://cdnjs.cloudflare.com/ajax/libs/normalize/4.2.0/normalize.min.css"rel="stylesheet"type="text/css"/><linkhref="https://fonts.googleapis.com/css?family=Lato|Roboto+Mono"rel="stylesheet"type="text/css"/><linkhref="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.6.3/css/font-awesome.min.css"rel="stylesheet"type="text/css"/><linkhref="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"rel="stylesheet"type="text/css"/><script>documenterBaseURL=".."</script><scriptsrc="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.2.0/require.min.js"data-main="../assets/documenter.js"></script><scriptsrc="../siteinfo.js"></script><scriptsrc="../../versions.js"></script><linkhref="../assets/documenter.css"rel="stylesheet"type="text/css"/></head><body><navclass="toc"><h1>Examples.jl</h1><selectid="version-selector"onChange="window.location.href=this.value"style="visibility: hidden"></select><formclass="search"id="search-form"action="../search.html"><inputid="search-query"name="q"type="text"placeholder="Search docs"/></form><ul><li><aclass="toctext"href="../index.html"><strong>1.</strong> Introduction</a></li><li><aclass="toctext"href="../fileformat.html"><strong>2.</strong> File Format</a></li><li><aclass="toctext"href="../pipeline.html"><strong>3.</strong> Processing pipeline</a></li><li><aclass="toctext"href="../outputformats.html"><strong>4.</strong> Output formats</a></li><li><aclass="toctext"href="../customprocessing.html"><strong>5.</strong> Custom pre- and post-processing</a></li><li><aclass="toctext"href="../documenter.html"><strong>6.</strong> Interaction with Documenter.jl</a></li><liclass="current"><aclass="toctext"href="example.html"><strong>7.</strong> Example</a><ulclass="internal"><li><aclass="toctext"href="#Rational-numbers-in-Julia-1">Rational numbers in Julia</a></li></ul></li></ul></nav><articleid="docs"><header><nav><ul><li><ahref="example.html"><strong>7.</strong> Example</a></li></ul><aclass="edit-page"href="https://github.com/fredrikekre/Examples.jl/blob/master/docs/src/generated/example.md"><spanclass="fa"></span> Edit on GitHub</a></nav><hr/><divid="topbar"><span>7. Example</span><aclass="fa fa-bars"href="#"></a></div></header><h1><aclass="nav-anchor"id="**7.**-Example-1"href="#**7.**-Example-1"><strong>7.</strong> Example</a></h1><p><em>Output generated with Examples.jl based on<ahref="../../../examples/example.jl">this</a> source file.</em></p><p>This is an example source file for input to Examples.jl.</p><p>If you are reading this you are seeing the markdown output generated from the source file, here you can see the corresponding notebook output: <ahref="example.ipynb">example.ipynb</a></p><h2><aclass="nav-anchor"id="Rational-numbers-in-Julia-1"href="#Rational-numbers-in-Julia-1">Rational numbers in Julia</a></h2><p>Rational number in julia can be constructed with the <code>//</code> operator:</p><div><pre><codeclass="language-julia">x = 1//3
<htmllang="en"><head><metacharset="UTF-8"/><metaname="viewport"content="width=device-width, initial-scale=1.0"/><title>7. Example · Examples.jl</title><linkhref="https://cdnjs.cloudflare.com/ajax/libs/normalize/4.2.0/normalize.min.css"rel="stylesheet"type="text/css"/><linkhref="https://fonts.googleapis.com/css?family=Lato|Roboto+Mono"rel="stylesheet"type="text/css"/><linkhref="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.6.3/css/font-awesome.min.css"rel="stylesheet"type="text/css"/><linkhref="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"rel="stylesheet"type="text/css"/><script>documenterBaseURL=".."</script><scriptsrc="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.2.0/require.min.js"data-main="../assets/documenter.js"></script><scriptsrc="../siteinfo.js"></script><scriptsrc="../../versions.js"></script><linkhref="../assets/documenter.css"rel="stylesheet"type="text/css"/></head><body><navclass="toc"><h1>Examples.jl</h1><selectid="version-selector"onChange="window.location.href=this.value"style="visibility: hidden"></select><formclass="search"id="search-form"action="../search.html"><inputid="search-query"name="q"type="text"placeholder="Search docs"/></form><ul><li><aclass="toctext"href="../index.html"><strong>1.</strong> Introduction</a></li><li><aclass="toctext"href="../fileformat.html"><strong>2.</strong> File Format</a></li><li><aclass="toctext"href="../pipeline.html"><strong>3.</strong> Processing pipeline</a></li><li><aclass="toctext"href="../outputformats.html"><strong>4.</strong> Output formats</a></li><li><aclass="toctext"href="../customprocessing.html"><strong>5.</strong> Custom pre- and post-processing</a></li><li><aclass="toctext"href="../documenter.html"><strong>6.</strong> Interaction with Documenter.jl</a></li><liclass="current"><aclass="toctext"href="example.html"><strong>7.</strong> Example</a><ulclass="internal"></ul></li></ul></nav><articleid="docs"><header><nav><ul><li><ahref="example.html"><strong>7.</strong> Example</a></li></ul><aclass="edit-page"href="https://github.com/fredrikekre/Examples.jl/blob/master/docs/src/generated/example.md"><spanclass="fa"></span> Edit on GitHub</a></nav><hr/><divid="topbar"><span>7. Example</span><aclass="fa fa-bars"href="#"></a></div></header><h1><aclass="nav-anchor"id="**7.**-Example-1"href="#**7.**-Example-1"><strong>7.</strong> Example</a></h1><p>This is an example for Examples.jl. The source file can be found <ahref="https://github.com/fredrikekre/Examples.jl/blob/master/examples/example.jl">here</a>. The generated markdown can be found here:<ahref="example.html"><code>example.md</code></a>, the generated notebook can be found here: <ahref="https://nbviewer.jupyter.org/github/fredrikekre/Examples.jl/blob/gh-pages/latest/generated/example.ipynb"><code>example.ipynb</code></a>, and the plain script output can be found here: <ahref="example.jl"><code>example.jl</code></a>.</p><h3><aclass="nav-anchor"id="Rational-numbers-in-Julia-1"href="#Rational-numbers-in-Julia-1">Rational numbers in Julia</a></h3><p>Rational number in julia can be constructed with the <code>//</code> operator:</p><div><pre><codeclass="language-julia">x = 1//3
y = 2//5</code></pre><pre><codeclass="language-none">2//5</code></pre></div><p>Operations with rational number returns a new rational number</p><div><pre><codeclass="language-julia">x + y</code></pre><pre><codeclass="language-none">11//15</code></pre></div><div><pre><codeclass="language-julia">x * y</code></pre><pre><codeclass="language-none">2//15</code></pre></div><p>Everytime a rational number is constructed, it will be simplified using the <code>gcd</code> function, for example <code>2//4</code> simplifies to <code>1//2</code>:</p><div><pre><codeclass="language-julia">2//4</code></pre><pre><codeclass="language-none">1//2</code></pre></div><p>and <code>2//4 + 2//4</code> simplifies to <code>1//1</code>:</p><div><pre><codeclass="language-julia">2//4 + 2//4</code></pre><pre><codeclass="language-none">1//1</code></pre></div><footer><hr/><aclass="previous"href="../documenter.html"><spanclass="direction">Previous</span><spanclass="title"><strong>6.</strong> Interaction with Documenter.jl</span></a></footer></article></body></html>
@ -17,4 +17,4 @@ Here is an example with some code
@@ -17,4 +17,4 @@ Here is an example with some code
```@example
x = sin.(cos.([1, 2, 3]))
y = x.^2 - x
```</code></pre><sectionclass="docstring"><divclass="docstring-header"><aclass="docstring-binding"id="Examples.markdown"href="#Examples.markdown"><code>Examples.markdown</code></a> — <spanclass="docstring-category">Function</span>.</div><div><div><pre><codeclass="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 <ahref="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>codefence</code>: A<code>Pair</code> of opening and closing code fence. Defaults to<pre><codeclass="language-none">"```julia" =>"```"</code></pre>if<code>documenter = false</code> and<pre><codeclass="language-none">"```@example $(name)" =>"```"</code></pre>if <code>documenter = true</code>.</li><li><code>documenter</code>: boolean that says if the output is intended to use with Documenter.jl. Defaults to <code>false</code>. See the the manual section on <ahref="documenter.html#Interaction-with-Documenter-1">Interaction with Documenter</a>.</li></ul></div></div><aclass="source-link"target="_blank"href="https://github.com/fredrikekre/Examples.jl/blob/ac317e6cc42587b921a19f3dd5c16f2c8ea84567/src/Examples.jl#L160-L184">source</a></section><h2><aclass="nav-anchor"id="Notebook-output-1"href="#Notebook-output-1"><strong>4.2.</strong> Notebook output</a></h2><sectionclass="docstring"><divclass="docstring-header"><aclass="docstring-binding"id="Examples.notebook"href="#Examples.notebook"><code>Examples.notebook</code></a> — <spanclass="docstring-category">Function</span>.</div><div><div><pre><codeclass="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 <ahref="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>false</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>false</code>. See the the manual section on <ahref="documenter.html#Interaction-with-Documenter-1">Interaction with Documenter</a>.</li></ul></div></div><aclass="source-link"target="_blank"href="https://github.com/fredrikekre/Examples.jl/blob/ac317e6cc42587b921a19f3dd5c16f2c8ea84567/src/Examples.jl#L267-L283">source</a></section><h2><aclass="nav-anchor"id="Script-output-1"href="#Script-output-1"><strong>4.3.</strong> Script output</a></h2><sectionclass="docstring"><divclass="docstring-header"><aclass="docstring-binding"id="Examples.script"href="#Examples.script"><code>Examples.script</code></a> — <spanclass="docstring-category">Function</span>.</div><div><div><pre><codeclass="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 <ahref="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><aclass="source-link"target="_blank"href="https://github.com/fredrikekre/Examples.jl/blob/ac317e6cc42587b921a19f3dd5c16f2c8ea84567/src/Examples.jl#L93-L104">source</a></section><footer><hr/><aclass="previous"href="pipeline.html"><spanclass="direction">Previous</span><spanclass="title"><strong>3.</strong> Processing pipeline</span></a><aclass="next"href="customprocessing.html"><spanclass="direction">Next</span><spanclass="title"><strong>5.</strong> Custom pre- and post-processing</span></a></footer></article></body></html>
```</code></pre><sectionclass="docstring"><divclass="docstring-header"><aclass="docstring-binding"id="Examples.markdown"href="#Examples.markdown"><code>Examples.markdown</code></a> — <spanclass="docstring-category">Function</span>.</div><div><div><pre><codeclass="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 <ahref="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 <ahref="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><codeclass="language-none">"```@example $(name)" =>"```"</code></pre>if <code>documenter = true</code> and<pre><codeclass="language-none">"```julia" =>"```"</code></pre>if <code>documenter = false</code>.</li></ul></div></div><aclass="source-link"target="_blank"href="https://github.com/fredrikekre/Examples.jl/blob/98d31ef42d93fd2a2cc8e43da290b0140f29266e/src/Examples.jl#L160-L184">source</a></section><h2><aclass="nav-anchor"id="Notebook-output-1"href="#Notebook-output-1"><strong>4.2.</strong> Notebook output</a></h2><sectionclass="docstring"><divclass="docstring-header"><aclass="docstring-binding"id="Examples.notebook"href="#Examples.notebook"><code>Examples.notebook</code></a> — <spanclass="docstring-category">Function</span>.</div><div><div><pre><codeclass="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 <ahref="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 <ahref="documenter.html#Interaction-with-Documenter-1">Interaction with Documenter</a>.</li></ul></div></div><aclass="source-link"target="_blank"href="https://github.com/fredrikekre/Examples.jl/blob/98d31ef42d93fd2a2cc8e43da290b0140f29266e/src/Examples.jl#L271-L287">source</a></section><h2><aclass="nav-anchor"id="Script-output-1"href="#Script-output-1"><strong>4.3.</strong> Script output</a></h2><sectionclass="docstring"><divclass="docstring-header"><aclass="docstring-binding"id="Examples.script"href="#Examples.script"><code>Examples.script</code></a> — <spanclass="docstring-category">Function</span>.</div><div><div><pre><codeclass="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 <ahref="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><aclass="source-link"target="_blank"href="https://github.com/fredrikekre/Examples.jl/blob/98d31ef42d93fd2a2cc8e43da290b0140f29266e/src/Examples.jl#L93-L104">source</a></section><footer><hr/><aclass="previous"href="pipeline.html"><spanclass="direction">Previous</span><spanclass="title"><strong>3.</strong> Processing pipeline</span></a><aclass="next"href="customprocessing.html"><spanclass="direction">Next</span><spanclass="title"><strong>5.</strong> Custom pre- and post-processing</span></a></footer></article></body></html>
@ -157,7 +157,7 @@ var documenterSearchIndex = {"docs": [
@@ -157,7 +157,7 @@ var documenterSearchIndex = {"docs": [
"page":"4. Output formats",
"title":"Examples.markdown",
"category":"function",
"text":"Examples.markdown(inputfile, outputdir; kwargs...)\n\nGenerate a markdown file from inputfile and write the result to the directoryoutputdir.\n\nKeyword arguments:\n\nname: name of the output file, excluding .md. name is also used to name all the @example blocks. Defaults to the filename of inputfile.\npreprocess, postprocess: custom pre- and post-processing functions, see the Custom pre- and post-processing section of the manual. Defaults to identity.\ncodefence: A Pair of opening and closing code fence. Defaults to\n\"```julia\" => \"```\"\nif documenter = false and\n\"```@example $(name)\" => \"```\"\nif documenter = true.\ndocumenter: boolean that says if the output is intended to use with Documenter.jl. Defaults to false. See the the manual section on Interaction with Documenter.\n\n\n\n\n\n"
"text":"Examples.markdown(inputfile, outputdir; kwargs...)\n\nGenerate a markdown file from inputfile and write the result to the directoryoutputdir.\n\nKeyword arguments:\n\nname: name of the output file, excluding .md. name is also used to name all the @example blocks. Defaults to the filename of inputfile.\npreprocess, postprocess: custom pre- and post-processing functions, see the Custom pre- and post-processing section of the manual. Defaults to identity.\ndocumenter: boolean that tells if the output is intended to use with Documenter.jl. Defaults to true. See the the manual section on Interaction with Documenter.\ncodefence: A Pair of opening and closing code fence. Defaults to\n\"```@example $(name)\" => \"```\"\nif documenter = true and\n\"```julia\" => \"```\"\nif documenter = false.\n\n\n\n\n\n"
},
{
@ -173,7 +173,7 @@ var documenterSearchIndex = {"docs": [
@@ -173,7 +173,7 @@ var documenterSearchIndex = {"docs": [
"page":"4. Output formats",
"title":"Examples.notebook",
"category":"function",
"text":"Examples.notebook(inputfile, outputdir; kwargs...)\n\nGenerate a notebook from inputfile and write the result to outputdir.\n\nKeyword arguments:\n\nname: name of the output file, excluding .ipynb. Defaults to the filename of inputfile.\npreprocess, postprocess: custom pre- and post-processing functions, see the Custom pre- and post-processing section of the manual. Defaults to identity.\nexecute: a boolean deciding if the generated notebook should also be executed or not. Defaults to false.\ndocumenter: boolean that says if the source contains Documenter.jl specific things to filter out during notebook generation. Defaults to false. See the the manual section on Interaction with Documenter.\n\n\n\n\n\n"
"text":"Examples.notebook(inputfile, outputdir; kwargs...)\n\nGenerate a notebook from inputfile and write the result to outputdir.\n\nKeyword arguments:\n\nname: name of the output file, excluding .ipynb. Defaults to the filename of inputfile.\npreprocess, postprocess: custom pre- and post-processing functions, see the Custom pre- and post-processing section of the manual. Defaults to identity.\nexecute: a boolean deciding if the generated notebook should also be executed or not. Defaults to true.\ndocumenter: boolean that says if the source contains Documenter.jl specific things to filter out during notebook generation. Defaults to true. See the the manual section on Interaction with Documenter.\n\n\n\n\n\n"
},
{
@ -237,7 +237,7 @@ var documenterSearchIndex = {"docs": [
@@ -237,7 +237,7 @@ var documenterSearchIndex = {"docs": [
@ -245,7 +245,7 @@ var documenterSearchIndex = {"docs": [
@@ -245,7 +245,7 @@ var documenterSearchIndex = {"docs": [
"page":"7. Example",
"title":"7. Example",
"category":"section",
"text":"Output generated with Examples.jl based on this source file.This is an example source file for input to Examples.jl.If you are reading this you are seeing the markdown output generated from the source file, here you can see the corresponding notebook output: example.ipynb"
"text":"This is an example for Examples.jl. The source file can be found here. The generated markdown can be found here: example.md, the generated notebook can be found here: example.ipynb, and the plain script output can be found here: example.jl."