Latest docs

gh-pages
Matti Pastell 2016-04-20 11:51:55 +03:00
parent a2747535c7
commit 483f2c97a4
5 changed files with 90 additions and 49 deletions

Binary file not shown.

Binary file not shown.

View File

@ -212,10 +212,11 @@
<li><a href=".#Usage-1">Usage</a><ul>
<li><a href=".#Weave-1">Weave</a></li>
<li><a href=".#Tangle-1">Tangle</a></li>
<li><a href=".#Supported-formats-1">Supported formats</a></li>
<li><a href=".#Get-supported-formats-1">Get supported formats</a></li>
<li><a href=".#Set-default-chunk-options-1">Set default chunk options</a></li>
</ul>
</li>
<li><a href=".#Index-1">Index</a></li>
<li><a href=".#Function-index-1">Function index</a></li>
</ul>
<p><a id='Document-syntax-1'></a></p>
<h1 id="document-syntax">Document syntax</h1>
@ -284,7 +285,7 @@ weave(Pkg.dir(&quot;Weave&quot;,&quot;examples&quot;,&quot;gadfly_sample.mdw&quo
<p><a id='Weave.weave-Tuple{Any}' href='#Weave.weave-Tuple{Any}'>#</a>
<strong><code>Weave.weave</code></strong> &mdash; <em>Method</em>.</p>
<hr />
<p>weave(source ; doctype = "pandoc", plotlib="Gadfly", informat="noweb", out_path=:doc, fig_path = "figures", fig_ext = nothing)</p>
<p><code>weave(source ; doctype = "pandoc", plotlib="Gadfly", informat="noweb", out_path=:doc, fig_path = "figures", fig_ext = nothing)</code></p>
<p>Weave an input document to output file.</p>
<ul>
<li><code>doctype</code>: see <code>list_out_formats()</code></li>
@ -303,14 +304,14 @@ weave(Pkg.dir(&quot;Weave&quot;,&quot;examples&quot;,&quot;gadfly_sample.mdw&quo
<p><a id='Weave.tangle-Tuple{Any}' href='#Weave.tangle-Tuple{Any}'>#</a>
<strong><code>Weave.tangle</code></strong> &mdash; <em>Method</em>.</p>
<hr />
<p>tangle(source ; out_path=:doc, informat="noweb")</p>
<p><code>tangle(source ; out_path=:doc, informat="noweb")</code></p>
<p>Tangle source code from input document to .jl file.</p>
<ul>
<li><code>informat</code>: <code>"noweb"</code> of <code>"markdown"</code></li>
<li><code>out_path</code>: Path where the output is generated. Can be: <code>:doc</code>: Path of the source document, <code>:pwd</code>: Julia working directory, <code>"somepath"</code>: Path as a AbstractString e.g <code>"/home/mpastell/weaveout"</code></li>
</ul>
<p><a id='Supported-formats-1'></a></p>
<h2 id="supported-formats">Supported formats</h2>
<p><a id='Get-supported-formats-1'></a></p>
<h2 id="get-supported-formats">Get supported formats</h2>
<p>You can get a list of supported output formats:</p>
<pre><code>julia&gt; list_out_formats()
pandoc: Pandoc markdown
@ -321,9 +322,44 @@ asciidoc: AsciiDoc
tex: Latex with custom code environments
</code></pre>
<p><a id='Index-1'></a></p>
<h1 id="index">Index</h1>
<p>{docs} list_out_formats()</p>
<p><a id='Set-default-chunk-options-1'></a></p>
<h2 id="set-default-chunk-options">Set default chunk options</h2>
<p>You can set or alter the default chunk options for a document either before running weave or inside the weaved document. You can e.g. use a hidden chunk in the beginning of the source document to set the options:</p>
<pre><code>&lt;&lt;echo = false&gt;&gt;=
import Weave
Weave.set_chunk_defaults(Dict{Symbol, Any}(
:out_width =&gt; &quot;\\0.5linewidth&quot;,
:results =&gt; &quot;tex&quot;
))
@
</code></pre>
<p><a id='Weave.set_chunk_defaults-Tuple{Any}' href='#Weave.set_chunk_defaults-Tuple{Any}'>#</a>
<strong><code>Weave.set_chunk_defaults</code></strong> &mdash; <em>Method</em>.</p>
<hr />
<p><code>set_chunk_defaults(opts::Dict{Symbol, Any})</code></p>
<p>Set default options for code chunks, use get_chunk_defaults to see the current values.</p>
<p>e.g. set default dpi to 200 and fig_width to 8</p>
<pre><code>julia&gt; set_chunk_defaults(Dict{Symbol, Any}(:dpi =&gt; 200, fig_width =&gt; 8))
</code></pre>
<p><a id='Weave.get_chunk_defaults-Tuple{}' href='#Weave.get_chunk_defaults-Tuple{}'>#</a>
<strong><code>Weave.get_chunk_defaults</code></strong> &mdash; <em>Method</em>.</p>
<hr />
<p><code>get_chunk_defaults()</code></p>
<p>Get default options used for code chunks.</p>
<p><a id='Weave.restore_chunk_defaults-Tuple{}' href='#Weave.restore_chunk_defaults-Tuple{}'>#</a>
<strong><code>Weave.restore_chunk_defaults</code></strong> &mdash; <em>Method</em>.</p>
<hr />
<p><code>restore_chunk_defaults()</code></p>
<p>Restore Weave.jl default chunk options</p>
<p><a id='Function-index-1'></a></p>
<h1 id="function-index">Function index</h1>
<ul>
<li><a href=".#Weave.get_chunk_defaults-Tuple{}"><code>Weave.get_chunk_defaults</code></a></li>
<li><a href=".#Weave.restore_chunk_defaults-Tuple{}"><code>Weave.restore_chunk_defaults</code></a></li>
<li><a href=".#Weave.set_chunk_defaults-Tuple{Any}"><code>Weave.set_chunk_defaults</code></a></li>
<li><a href=".#Weave.tangle-Tuple{Any}"><code>Weave.tangle</code></a></li>
<li><a href=".#Weave.weave-Tuple{Any}"><code>Weave.weave</code></a></li>
</ul>

File diff suppressed because one or more lines are too long

View File

@ -4,7 +4,7 @@
<url>
<loc>None/</loc>
<lastmod>2016-04-19</lastmod>
<lastmod>2016-04-20</lastmod>
<changefreq>daily</changefreq>
</url>