Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@brittnylapierre
brittnylapierre committed Dec 8, 2023
1 parent 41d26a4 commit 8650549
Show file tree
Hide file tree
Showing 7 changed files with 69 additions and 56 deletions.
1 change: 0 additions & 1 deletion genindex.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,6 @@
</ul>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="markdown.html">Markdown Files</a></li>
<li class="toctree-l1"><a class="reference internal" href="notebooks.html">Content with notebooks</a></li>
<li class="toctree-l1"><a class="reference internal" href="markdown-notebooks.html">Notebooks with MyST Markdown</a></li>
</ul>

Expand Down
2 changes: 0 additions & 2 deletions intro.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,6 @@
</ul>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="markdown.html">Markdown Files</a></li>
<li class="toctree-l1"><a class="reference internal" href="notebooks.html">Content with notebooks</a></li>
<li class="toctree-l1"><a class="reference internal" href="markdown-notebooks.html">Notebooks with MyST Markdown</a></li>
</ul>

Expand Down Expand Up @@ -378,7 +377,6 @@ <h1>Welcome to your Jupyter Book<a class="headerlink" href="#welcome-to-your-jup
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="markdown.html">Markdown Files</a></li>
<li class="toctree-l1"><a class="reference internal" href="notebooks.html">Content with notebooks</a></li>
<li class="toctree-l1"><a class="reference internal" href="markdown-notebooks.html">Notebooks with MyST Markdown</a></li>
</ul>
</div>
Expand Down
83 changes: 33 additions & 50 deletions notebooks.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

<title>Content with notebooks &#8212; My sample book</title>
<title>&lt;no title&gt; &#8212; My sample book</title>



Expand Down Expand Up @@ -62,8 +62,6 @@
const thebe_selector_output = ".output, .cell_output"
</script>
<script async="async" src="_static/sphinx-thebe.js"></script>
<script>window.MathJax = {"options": {"processHtmlClass": "tex2jax_process|mathjax_process|math|output_area"}}</script>
<script defer="defer" src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
<script>DOCUMENTATION_OPTIONS.pagename = 'notebooks';</script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
Expand Down Expand Up @@ -170,9 +168,8 @@
</a>
</li>
</ul>
<ul class="current nav bd-sidenav">
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="markdown.html">Markdown Files</a></li>
<li class="toctree-l1 current active"><a class="current reference internal" href="#">Content with notebooks</a></li>
<li class="toctree-l1"><a class="reference internal" href="markdown-notebooks.html">Notebooks with MyST Markdown</a></li>
</ul>

Expand Down Expand Up @@ -359,7 +356,7 @@


<div id="jb-print-docs-body" class="onlyprint">
<h1>Content with notebooks</h1>
<h1><no title></h1>
<!-- Table of contents -->
<div id="print-main-content">
<div id="jb-print-toc">
Expand All @@ -368,11 +365,9 @@ <h1>Content with notebooks</h1>
<h2> Contents </h2>
</div>
<nav aria-label="Page">
<ul class="visible nav section-nav flex-column">
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#markdown-notebooks">Markdown + notebooks</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#myst-markdown">MyST markdown</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#code-blocks-and-outputs">Code blocks and outputs</a></li>
<ul class="simple visible nav section-nav flex-column">
</ul>

</nav>
</div>
</div>
Expand All @@ -383,40 +378,7 @@ <h2> Contents </h2>
<div id="searchbox"></div>
<article class="bd-article" role="main">

<section class="tex2jax_ignore mathjax_ignore" id="content-with-notebooks">
<h1>Content with notebooks<a class="headerlink" href="#content-with-notebooks" title="Permalink to this heading">#</a></h1>
<p>You can also create content with Jupyter Notebooks. This means that you can include
code blocks and their outputs in your book.</p>
<section id="markdown-notebooks">
<h2>Markdown + notebooks<a class="headerlink" href="#markdown-notebooks" title="Permalink to this heading">#</a></h2>
<p>As it is markdown, you can embed images, HTML, etc into your posts!</p>
<p><img alt="" src="https://myst-parser.readthedocs.io/en/latest/_static/logo-wide.svg" /></p>
<p>You can also <span class="math notranslate nohighlight">\(add_{math}\)</span> and</p>
<div class="math notranslate nohighlight">
\[
math^{blocks}
\]</div>
<p>or</p>
<div class="math notranslate nohighlight">
\[\begin{split}
\begin{aligned}
\mbox{mean} la_{tex} \\ \\
math blocks
\end{aligned}
\end{split}\]</div>
<p>But make sure you $Escape $your $dollar signs $you want to keep!</p>
</section>
<section id="myst-markdown">
<h2>MyST markdown<a class="headerlink" href="#myst-markdown" title="Permalink to this heading">#</a></h2>
<p>MyST markdown works in Jupyter Notebooks as well. For more information about MyST markdown, check
out <a class="reference external" href="https://jupyterbook.org/content/myst.html">the MyST guide in Jupyter Book</a>,
or see <a class="reference external" href="https://myst-parser.readthedocs.io/en/latest/">the MyST markdown documentation</a>.</p>
</section>
<section id="code-blocks-and-outputs">
<h2>Code blocks and outputs<a class="headerlink" href="#code-blocks-and-outputs" title="Permalink to this heading">#</a></h2>
<p>Jupyter Book will also embed your code blocks and output in your book.
For example, here’s some sample Matplotlib code:</p>
<div class="cell docutils container">
<div class="cell docutils container">
<div class="cell_input docutils container">
<div class="highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">matplotlib.pyplot</span> <span class="k">as</span> <span class="nn">plt</span>
<span class="kn">import</span> <span class="nn">pandas</span> <span class="k">as</span> <span class="nn">pd</span>
Expand All @@ -441,10 +403,33 @@ <h2>Code blocks and outputs<a class="headerlink" href="#code-blocks-and-outputs"
<img alt="_images/a1c4696b46f268a948cb883cfe4f8237e960c13a9fdc1ea40ef29635cae456d6.png" src="_images/a1c4696b46f268a948cb883cfe4f8237e960c13a9fdc1ea40ef29635cae456d6.png" />
</div>
</div>
<div class="cell docutils container">
<div class="cell_input docutils container">
<div class="highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">pandas.plotting</span> <span class="kn">import</span> <span class="n">parallel_coordinates</span>
<span class="n">df</span> <span class="o">=</span> <span class="n">pd</span><span class="o">.</span><span class="n">read_csv</span><span class="p">(</span><span class="s1">&#39;cleaned.csv&#39;</span><span class="p">)</span>
<span class="n">plt</span><span class="o">.</span><span class="n">figure</span><span class="p">()</span>
<span class="n">parallel_coordinates</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="s2">&quot;geo&quot;</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="cell_output docutils container">
<div class="output traceback highlight-ipythontb notranslate"><div class="highlight"><pre><span></span><span class="gt">---------------------------------------------------------------------------</span>
<span class="ne">NameError</span><span class="g g-Whitespace"> </span>Traceback (most recent call last)
<span class="n">Cell</span> <span class="n">In</span><span class="p">[</span><span class="mi">2</span><span class="p">],</span> <span class="n">line</span> <span class="mi">4</span>
<span class="g g-Whitespace"> </span><span class="mi">2</span> <span class="n">df</span> <span class="o">=</span> <span class="n">pd</span><span class="o">.</span><span class="n">read_csv</span><span class="p">(</span><span class="s1">&#39;cleaned.csv&#39;</span><span class="p">)</span>
<span class="g g-Whitespace"> </span><span class="mi">3</span> <span class="n">plt</span><span class="o">.</span><span class="n">figure</span><span class="p">()</span>
<span class="ne">----&gt; </span><span class="mi">4</span> <span class="n">parallel_coordinates</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="s2">&quot;geo&quot;</span><span class="p">)</span>

<span class="ne">NameError</span>: name &#39;data&#39; is not defined
</pre></div>
</div>
<div class="output text_plain highlight-myst-ansi notranslate"><div class="highlight"><pre><span></span>&lt;Figure size 640x480 with 0 Axes&gt;
</pre></div>
</div>
</div>
</div>
<p>There is a lot more that you can do with outputs (such as including interactive outputs)
with your book. For more information about this, see <a class="reference external" href="https://jupyterbook.org">the Jupyter Book documentation</a></p>
</section>
</section>

<script type="text/x-thebe-config">
{
Expand Down Expand Up @@ -508,11 +493,9 @@ <h2>Code blocks and outputs<a class="headerlink" href="#code-blocks-and-outputs"
<i class="fa-solid fa-list"></i> Contents
</div>
<nav class="bd-toc-nav page-toc">
<ul class="visible nav section-nav flex-column">
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#markdown-notebooks">Markdown + notebooks</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#myst-markdown">MyST markdown</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#code-blocks-and-outputs">Code blocks and outputs</a></li>
<ul class="simple visible nav section-nav flex-column">
</ul>

</nav></div>

</div></div>
Expand Down
3 changes: 2 additions & 1 deletion objects.inv
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,5 @@
# Version:
# The remainder of this file is compressed using zlib.
xڅ��
�0D���� ���B���B�j�Y�+6�j�jz 3�f�Zm%��ay0i��=��S\��O�-;b��>4!�D�S���Z׶���D��RWJ�쒝���S�63Yb�>��uC�mw������EEr���G�1~�dkp<xs�g�D��r��=�(���xVd���.Wk0h��?I oCˡ�
�0D���� ���C�,����,�Y�+6�j�jz 3�f�9e$��ay�I��=䣺+��p�B�4�$e}h|�:�
� �nm�-��JQ%��ԙ%;i��Eilf 0Ę~*�-��������1���ƙ� &c��V�x�������b�'�(��9.Ȭ�LlV�A�y&�~��(�mT��
33 changes: 33 additions & 0 deletions reports/notebooks.err.log
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
Traceback (most recent call last):
File "/home/brittny/.local/lib/python3.10/site-packages/jupyter_cache/executors/utils.py", line 58, in single_nb_execution
executenb(
File "/home/brittny/.local/lib/python3.10/site-packages/nbclient/client.py", line 1305, in execute
return NotebookClient(nb=nb, resources=resources, km=km, **kwargs).execute()
File "/home/brittny/.local/lib/python3.10/site-packages/jupyter_core/utils/__init__.py", line 173, in wrapped
return loop.run_until_complete(inner)
File "/usr/lib/python3.10/asyncio/base_events.py", line 649, in run_until_complete
return future.result()
File "/home/brittny/.local/lib/python3.10/site-packages/nbclient/client.py", line 705, in async_execute
await self.async_execute_cell(
File "/home/brittny/.local/lib/python3.10/site-packages/nbclient/client.py", line 1058, in async_execute_cell
await self._check_raise_for_error(cell, cell_index, exec_reply)
File "/home/brittny/.local/lib/python3.10/site-packages/nbclient/client.py", line 914, in _check_raise_for_error
raise CellExecutionError.from_cell_and_msg(cell, exec_reply_content)
nbclient.exceptions.CellExecutionError: An error occurred while executing the following cell:
------------------
from pandas.plotting import parallel_coordinates
df = pd.read_csv('cleaned.csv')
plt.figure()
parallel_coordinates(data, "geo")
------------------


---------------------------------------------------------------------------
NameError Traceback (most recent call last)
Cell In[2], line 4
 2 df = pd.read_csv('cleaned.csv')
 3 plt.figure()
----> 4 parallel_coordinates(data, "geo")

NameError: name 'data' is not defined

1 change: 0 additions & 1 deletion search.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,6 @@
</ul>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="markdown.html">Markdown Files</a></li>
<li class="toctree-l1"><a class="reference internal" href="notebooks.html">Content with notebooks</a></li>
<li class="toctree-l1"><a class="reference internal" href="markdown-notebooks.html">Notebooks with MyST Markdown</a></li>
</ul>

Expand Down
Loading

0 comments on commit 8650549

Please sign in to comment.