Skip to content

Commit

Permalink
docs update
Browse files Browse the repository at this point in the history
  • Loading branch information
daizutabi committed May 8, 2019
1 parent ad465df commit ba01651
Show file tree
Hide file tree
Showing 15 changed files with 86 additions and 96 deletions.
4 changes: 2 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,8 @@ print(1)
Other language code can be executed if a kernel for the language has been installed. For example,

~~~copy
```javascript
console.log("Hello Javascript")
```julia
println("Hello, IJulia!")
```
~~~

Expand Down
2 changes: 1 addition & 1 deletion docs/user-guide/images.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Image Processing
# Image

In this section, we study how to embed images created by [Matplotlib](https://matplotlib.org/), [Bokeh](https://bokeh.pydata.org/en/latest/), [HoloViews](https://holoviews.org/), and [Altair](https://altair-viz.github.io/) libraries.

Expand Down
4 changes: 2 additions & 2 deletions docs/user-guide/kernel.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ $ npm install -g ijavascript
$ ijsinstall
~~~

~~~copy
~~~
```javascript
console.log("Hello, IJavascript!")
```
Expand All @@ -22,7 +22,7 @@ julia> using Pkg
julia> Pkg.add("IJulia")
~~~

~~~copy
~~~
```julia
println("Hello, IJulia!")
```
Expand Down
2 changes: 1 addition & 1 deletion site/404.html
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
<li class="toctree-l1"><a class="nav-item" href="/.">1 Home</a></li>
<li class="toctree-l1"><button class="section nav-item">User Guide</button>
<ul class="subnav">
<li class="toctree-l2"><a class="nav-item" href="/user-guide/images/">2 Image Processing</a></li>
<li class="toctree-l2"><a class="nav-item" href="/user-guide/images/">2 Image</a></li>
<li class="toctree-l2"><a class="nav-item" href="/user-guide/embed/">3 Embeded objects</a></li>
<li class="toctree-l2"><a class="nav-item" href="/user-guide/sympy/">4 SymPy and LaTeX</a></li>
<li class="toctree-l2"><a class="nav-item" href="/user-guide/script/">5 Standalone Script</a></li>
Expand Down
2 changes: 1 addition & 1 deletion site/about/license/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
<li class="toctree-l1"><a class="nav-item" href="../..">1 Home</a></li>
<li class="toctree-l1"><button class="section nav-item">User Guide</button>
<ul class="subnav">
<li class="toctree-l2"><a class="nav-item" href="../../user-guide/images/">2 Image Processing</a></li>
<li class="toctree-l2"><a class="nav-item" href="../../user-guide/images/">2 Image</a></li>
<li class="toctree-l2"><a class="nav-item" href="../../user-guide/embed/">3 Embeded objects</a></li>
<li class="toctree-l2"><a class="nav-item" href="../../user-guide/sympy/">4 SymPy and LaTeX</a></li>
<li class="toctree-l2"><a class="nav-item" href="../../user-guide/script/">5 Standalone Script</a></li>
Expand Down
2 changes: 1 addition & 1 deletion site/about/release-notes/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
<li class="toctree-l1"><a class="nav-item" href="../..">1 Home</a></li>
<li class="toctree-l1"><button class="section nav-item">User Guide</button>
<ul class="subnav">
<li class="toctree-l2"><a class="nav-item" href="../../user-guide/images/">2 Image Processing</a></li>
<li class="toctree-l2"><a class="nav-item" href="../../user-guide/images/">2 Image</a></li>
<li class="toctree-l2"><a class="nav-item" href="../../user-guide/embed/">3 Embeded objects</a></li>
<li class="toctree-l2"><a class="nav-item" href="../../user-guide/sympy/">4 SymPy and LaTeX</a></li>
<li class="toctree-l2"><a class="nav-item" href="../../user-guide/script/">5 Standalone Script</a></li>
Expand Down
122 changes: 61 additions & 61 deletions site/index.html

Large diffs are not rendered by default.

Binary file modified site/sitemap.xml.gz
Binary file not shown.
14 changes: 7 additions & 7 deletions site/user-guide/embed/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
<li class="toctree-l1"><a class="nav-item" href="../..">1 Home</a></li>
<li class="toctree-l1"><button class="section nav-item">User Guide</button>
<ul class="subnav">
<li class="toctree-l2"><a class="nav-item" href="../images/">2 Image Processing</a></li>
<li class="toctree-l2"><a class="nav-item" href="../images/">2 Image</a></li>
<li class="toctree-l2 current"><a class="nav-item current" href="./">3 Embeded objects</a>
<ul class="subnav">
<li class="toctree-l3"><a class="nav-item toc" href="#31-file-system">3.1 File system</a></li>
Expand Down Expand Up @@ -145,8 +145,8 @@ <h2 id="32-python-module-source"><span class="pheasant-header"><span class="head
<p>You can write to inspect the whole module content:</p>
<div class="pheasant-fenced-code"><div class="cell jupyter input"><div class="code"><pre><code class="python">import pheasant</code></pre></div>
<div class="report"><p><span class="count">[1]</span>
<span class="start">2019-05-08 08:36:39</span> (<span class="time">3.01ms</span>)
<span class="right"><span class="option">(run)</span> <span class="kernel">python3</span> (<span class="total">3.01ms</span>)</span></p></div></div></div>
<span class="start">2019-05-08 17:44:12</span> (<span class="time">15.6ms</span>)
<span class="right"><span class="option">(run)</span> <span class="kernel">python3</span> (<span class="total">15.6ms</span>)</span></p></div></div></div>

<div class="pheasant-fenced-code"><div class="cell embed source"><div class="code"><pre><code class="markdown">{%?pheasant%}</code></pre></div></div></div>

Expand All @@ -156,8 +156,8 @@ <h2 id="32-python-module-source"><span class="pheasant-header"><span class="head
<p>A part of the module can be specified as usual.</p>
<div class="pheasant-fenced-code"><div class="cell jupyter input"><div class="code"><pre><code class="python">from pheasant.renderers.jupyter.jupyter import Jupyter</code></pre></div>
<div class="report"><p><span class="count">[2]</span>
<span class="start">2019-05-08 08:36:39</span> (<span class="time">24.0ms</span>)
<span class="right"><span class="kernel">python3</span> (<span class="total">36.1ms</span>)</span></p></div></div></div>
<span class="start">2019-05-08 17:44:12</span> (<span class="time">25.1ms</span>)
<span class="right"><span class="kernel">python3</span> (<span class="total">62.3ms</span>)</span></p></div></div></div>

<div class="pheasant-fenced-code"><div class="cell embed source"><div class="code"><pre><code class="markdown">{%?Jupyter[:21]%}</code></pre></div></div></div>

Expand Down Expand Up @@ -196,8 +196,8 @@ <h2 id="33-include-other-file-as-markdown-source"><span class="pheasant-header">
<div class="pheasant-fenced-code"><div class="cell jupyter input"><div class="code"><pre><code class="python">def func(x, y):
return x + y</code></pre></div>
<div class="report"><p><span class="count">[3]</span>
<span class="start">2019-05-08 08:36:39</span> (<span class="time">4.00ms</span>)
<span class="right"><span class="kernel">python3</span> (<span class="total">54.1ms</span>)</span></p></div></div></div>
<span class="start">2019-05-08 17:44:12</span> (<span class="time">4.00ms</span>)
<span class="right"><span class="kernel">python3</span> (<span class="total">82.4ms</span>)</span></p></div></div></div>

<p>If the included file contains header statements, the document structure may be broken. For example, a file to be included contains:</p>
<div class="pheasant-header"><div class="other"><p class="caption"><span class="prefix">File</span> <span class="number">2</span>
Expand Down
4 changes: 2 additions & 2 deletions site/user-guide/images/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
<li class="toctree-l1"><a class="nav-item" href="../..">1 Home</a></li>
<li class="toctree-l1"><button class="section nav-item">User Guide</button>
<ul class="subnav">
<li class="toctree-l2 current"><a class="nav-item current" href="./">2 Image Processing</a>
<li class="toctree-l2 current"><a class="nav-item current" href="./">2 Image</a>
<ul class="subnav">
<li class="toctree-l3"><a class="nav-item toc" href="#21-matplotlib">2.1 Matplotlib</a></li>
<li class="toctree-l3"><a class="nav-item toc" href="#22-bokeh">2.2 Bokeh</a></li>
Expand Down Expand Up @@ -847,7 +847,7 @@

window.PyViz.comm_manager = CommManager()
</script>
<h1 id="2-image-processing"><span class="pheasant-header"><span class="header"><span class="number">2</span> <span class="title">Image Processing</span></span></span></h1>
<h1 id="2-image"><span class="pheasant-header"><span class="header"><span class="number">2</span> <span class="title">Image</span></span></span></h1>
<p>In this section, we study how to embed images created by <a href="https://matplotlib.org/">Matplotlib</a>, <a href="https://bokeh.pydata.org/en/latest/">Bokeh</a>, <a href="https://holoviews.org/">HoloViews</a>, and <a href="https://altair-viz.github.io/">Altair</a> libraries.</p>
<h2 id="21-matplotlib"><span class="pheasant-header"><span class="header"><span class="number">2.1</span> <span class="title">Matplotlib</span></span></span></h2>
<p>First, <code>figsize</code> of <code>figure</code> is set to <code>[2, 1.6]</code> to show small figures for saving space.</p>
Expand Down
18 changes: 4 additions & 14 deletions site/user-guide/kernel/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
<li class="toctree-l1"><a class="nav-item" href="../..">1 Home</a></li>
<li class="toctree-l1"><button class="section nav-item">User Guide</button>
<ul class="subnav">
<li class="toctree-l2"><a class="nav-item" href="../images/">2 Image Processing</a></li>
<li class="toctree-l2"><a class="nav-item" href="../images/">2 Image</a></li>
<li class="toctree-l2"><a class="nav-item" href="../embed/">3 Embeded objects</a></li>
<li class="toctree-l2"><a class="nav-item" href="../sympy/">4 SymPy and LaTeX</a></li>
<li class="toctree-l2"><a class="nav-item" href="../script/">5 Standalone Script</a></li>
Expand Down Expand Up @@ -86,11 +86,6 @@ <h2 id="61-ijavascript"><span class="pheasant-header"><span class="header"><span
console.log(&#34;Hello, IJavascript!&#34;)
```</code></pre></div></div></div>

<div class="pheasant-fenced-code"><div class="cached"><div class="cell jupyter input"><div class="code"><pre><code class="javascript">console.log(&#34;Hello, IJavascript!&#34;)</code></pre></div>
<div class="report"><p><span class="count">[1]</span>
<span class="start">2019-05-07 10:57:17</span> (<span class="time">8.01ms</span>)
<span class="right"><span class="kernel">javascript</span> (<span class="total">30.8ms</span>)</span></p></div></div><div class="cell jupyter stdout"><div class="code"><pre><code class="nohighlight">Hello, IJavascript!</code></pre></div></div></div></div>

<h2 id="62-ijulia"><span class="pheasant-header"><span class="header"><span class="number">6.2</span> <span class="title">IJulia</span></span></span></h2>
<div class="pheasant-fenced-code"><div class="cell embed source"><div class="code"><pre><code class="julia">julia&gt; using Pkg
julia&gt; Pkg.add(&#34;IJulia&#34;)</code></pre></div></div></div>
Expand All @@ -99,18 +94,13 @@ <h2 id="62-ijulia"><span class="pheasant-header"><span class="header"><span clas
println(&#34;Hello, IJulia!&#34;)
```</code></pre></div></div></div>

<div class="pheasant-fenced-code"><div class="cached"><div class="cell jupyter input"><div class="code"><pre><code class="julia">println(&#34;Hello, IJulia!&#34;)</code></pre></div>
<div class="report"><p><span class="count">[2]</span>
<span class="start">2019-05-07 10:57:25</span> (<span class="time">542ms</span>)
<span class="right"><span class="kernel">julia-1.1</span> (<span class="total">542ms</span>)</span></p></div></div><div class="cell jupyter stdout"><div class="code"><pre><code class="nohighlight">Hello, IJulia!</code></pre></div></div></div></div>

<h2 id="63-kernel-list"><span class="pheasant-header"><span class="header"><span class="number">6.3</span> <span class="title">Kernel list</span></span></span></h2>
<p>Mapping a language to kernel names can be obtained as a dictionary by <code>kernels.kernel_names</code> property:</p>
<div class="pheasant-fenced-code"><div class="cached"><div class="cell jupyter input"><div class="code"><pre><code class="python">from pheasant.renderers.jupyter.kernel import kernels
kernels.kernel_names</code></pre></div>
<div class="report"><p><span class="count">[3]</span>
<span class="start">2019-05-07 10:57:26</span> (<span class="time">12.0ms</span>)
<span class="right"><span class="kernel">python3</span> (<span class="total">2.68s</span>)</span></p></div></div><div class="cell jupyter output"><div class="code"><pre><code class="nohighlight">{&#39;javascript&#39;: [&#39;javascript&#39;], &#39;julia&#39;: [&#39;julia-1.1&#39;], &#39;python&#39;: [&#39;python3&#39;]}</code></pre></div></div></div></div></div>
<div class="report"><p><span class="count">[1]</span>
<span class="start">2019-05-08 17:43:26</span> (<span class="time">15.0ms</span>)
<span class="right"><span class="kernel">python3</span> (<span class="total">1.75s</span>)</span></p></div></div><div class="cell jupyter output"><div class="code"><pre><code class="nohighlight">{&#39;julia&#39;: [&#39;julia-1.1&#39;], &#39;python&#39;: [&#39;python3&#39;]}</code></pre></div></div></div></div></div>
<footer>
<div class="footer-buttons">
<div class="previous"><a href="../script/" title="Script"><span>Previous</span></a></div>
Expand Down
2 changes: 1 addition & 1 deletion site/user-guide/link/included/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
<li class="toctree-l1"><a class="nav-item" href="../../..">1 Home</a></li>
<li class="toctree-l1"><button class="section nav-item">User Guide</button>
<ul class="subnav">
<li class="toctree-l2"><a class="nav-item" href="../../images/">2 Image Processing</a></li>
<li class="toctree-l2"><a class="nav-item" href="../../images/">2 Image</a></li>
<li class="toctree-l2"><a class="nav-item" href="../../embed/">3 Embeded objects</a></li>
<li class="toctree-l2"><a class="nav-item" href="../../sympy/">4 SymPy and LaTeX</a></li>
<li class="toctree-l2"><a class="nav-item" href="../../script/">5 Standalone Script</a></li>
Expand Down
2 changes: 1 addition & 1 deletion site/user-guide/link/section/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
<li class="toctree-l1"><a class="nav-item" href="../../..">1 Home</a></li>
<li class="toctree-l1"><button class="section nav-item">User Guide</button>
<ul class="subnav">
<li class="toctree-l2"><a class="nav-item" href="../../images/">2 Image Processing</a></li>
<li class="toctree-l2"><a class="nav-item" href="../../images/">2 Image</a></li>
<li class="toctree-l2"><a class="nav-item" href="../../embed/">3 Embeded objects</a></li>
<li class="toctree-l2"><a class="nav-item" href="../../sympy/">4 SymPy and LaTeX</a></li>
<li class="toctree-l2"><a class="nav-item" href="../../script/">5 Standalone Script</a></li>
Expand Down
2 changes: 1 addition & 1 deletion site/user-guide/script/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
<li class="toctree-l1"><a class="nav-item" href="../..">1 Home</a></li>
<li class="toctree-l1"><button class="section nav-item">User Guide</button>
<ul class="subnav">
<li class="toctree-l2"><a class="nav-item" href="../images/">2 Image Processing</a></li>
<li class="toctree-l2"><a class="nav-item" href="../images/">2 Image</a></li>
<li class="toctree-l2"><a class="nav-item" href="../embed/">3 Embeded objects</a></li>
<li class="toctree-l2"><a class="nav-item" href="../sympy/">4 SymPy and LaTeX</a></li>
<li class="toctree-l2 current"><a class="nav-item current" href="./">5 Standalone Script</a>
Expand Down
2 changes: 1 addition & 1 deletion site/user-guide/sympy/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
<li class="toctree-l1"><a class="nav-item" href="../..">1 Home</a></li>
<li class="toctree-l1"><button class="section nav-item">User Guide</button>
<ul class="subnav">
<li class="toctree-l2"><a class="nav-item" href="../images/">2 Image Processing</a></li>
<li class="toctree-l2"><a class="nav-item" href="../images/">2 Image</a></li>
<li class="toctree-l2"><a class="nav-item" href="../embed/">3 Embeded objects</a></li>
<li class="toctree-l2 current"><a class="nav-item current" href="./">4 SymPy and LaTeX</a>
<ul class="subnav">
Expand Down

0 comments on commit ba01651

Please sign in to comment.