Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
arnaou committed Sep 25, 2024
1 parent a5b4bb7 commit a14204c
Show file tree
Hide file tree
Showing 7 changed files with 25 additions and 15 deletions.
4 changes: 4 additions & 0 deletions _sources/markdown-notebooks.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,3 +51,7 @@ If you have a markdown file and you'd like to quickly add YAML metadata to it, s
```
jupyter-book myst init path/to/markdownfile.md
```


```{tableofcontents}
```
2 changes: 1 addition & 1 deletion genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@
<li class="toctree-l1"><a class="reference internal" href="markdown.html">1. Alternative name</a></li>
<li class="toctree-l1"><a class="reference internal" href="notebooks.html">2. Content with notebooks</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="markdown-notebooks.html">3. Notebooks with MyST Markdown</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l2"><a class="reference internal" href="mymarkdownfile.html">3.4. Here’s my sample title</a></li>
<li class="toctree-l2"><a class="reference internal" href="mymarkdownfile.html">3.3.1. Here’s my sample title</a></li>
</ul>
</details></li>
</ul>
Expand Down
7 changes: 5 additions & 2 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@
<li class="toctree-l1"><a class="reference internal" href="markdown.html">1. Alternative name</a></li>
<li class="toctree-l1"><a class="reference internal" href="notebooks.html">2. Content with notebooks</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="markdown-notebooks.html">3. Notebooks with MyST Markdown</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l2"><a class="reference internal" href="mymarkdownfile.html">3.4. Here’s my sample title</a></li>
<li class="toctree-l2"><a class="reference internal" href="mymarkdownfile.html">3.3.1. Here’s my sample title</a></li>
</ul>
</details></li>
</ul>
Expand Down Expand Up @@ -407,7 +407,10 @@ <h1>Welcome to your Jupyter Book<a class="headerlink" href="#welcome-to-your-jup
<ul>
<li class="toctree-l1"><a class="reference internal" href="markdown.html">1. Alternative name</a></li>
<li class="toctree-l1"><a class="reference internal" href="notebooks.html">2. Content with notebooks</a></li>
<li class="toctree-l1"><a class="reference internal" href="markdown-notebooks.html">3. Notebooks with MyST Markdown</a></li>
<li class="toctree-l1"><a class="reference internal" href="markdown-notebooks.html">3. Notebooks with MyST Markdown</a><ul>
<li class="toctree-l2"><a class="reference internal" href="mymarkdownfile.html">3.3.1. Here’s my sample title</a></li>
</ul>
</li>
</ul>
</div>
</section>
Expand Down
11 changes: 7 additions & 4 deletions markdown-notebooks.html
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@
<script>DOCUMENTATION_OPTIONS.pagename = 'markdown-notebooks';</script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="3.4. Here’s my sample title" href="mymarkdownfile.html" />
<link rel="next" title="3.3.1. Here’s my sample title" href="mymarkdownfile.html" />
<link rel="prev" title="2. Content with notebooks" href="notebooks.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
Expand Down Expand Up @@ -184,7 +184,7 @@
<li class="toctree-l1"><a class="reference internal" href="markdown.html">1. Alternative name</a></li>
<li class="toctree-l1"><a class="reference internal" href="notebooks.html">2. Content with notebooks</a></li>
<li class="toctree-l1 current active has-children"><a class="current reference internal" href="#">3. Notebooks with MyST Markdown</a><details open="open"><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l2"><a class="reference internal" href="mymarkdownfile.html">3.4. Here’s my sample title</a></li>
<li class="toctree-l2"><a class="reference internal" href="mymarkdownfile.html">3.3.1. Here’s my sample title</a></li>
</ul>
</details></li>
</ul>
Expand Down Expand Up @@ -440,9 +440,12 @@ <h2><span class="section-number">3.3. </span>Quickly add YAML metadata for MyST
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">jupyter</span><span class="o">-</span><span class="n">book</span> <span class="n">myst</span> <span class="n">init</span> <span class="n">path</span><span class="o">/</span><span class="n">to</span><span class="o">/</span><span class="n">markdownfile</span><span class="o">.</span><span class="n">md</span>
</pre></div>
</div>
</section>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="mymarkdownfile.html">3.3.1. Here’s my sample title</a></li>
</ul>
</div>
</section>
</section>

<script type="text/x-thebe-config">
Expand Down Expand Up @@ -489,7 +492,7 @@ <h2><span class="section-number">3.3. </span>Quickly add YAML metadata for MyST
title="next page">
<div class="prev-next-info">
<p class="prev-next-subtitle">next</p>
<p class="prev-next-title"><span class="section-number">3.4. </span>Here’s my sample title</p>
<p class="prev-next-title"><span class="section-number">3.3.1. </span>Here’s my sample title</p>
</div>
<i class="fa-solid fa-angle-right"></i>
</a>
Expand Down
12 changes: 6 additions & 6 deletions mymarkdownfile.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<title>3.4. Here’s my sample title &#8212; DIG4BIO-workshops</title>
<title>3.3.1. Here’s my sample title &#8212; DIG4BIO-workshops</title>



Expand Down Expand Up @@ -183,7 +183,7 @@
<li class="toctree-l1"><a class="reference internal" href="markdown.html">1. Alternative name</a></li>
<li class="toctree-l1"><a class="reference internal" href="notebooks.html">2. Content with notebooks</a></li>
<li class="toctree-l1 current active has-children"><a class="reference internal" href="markdown-notebooks.html">3. Notebooks with MyST Markdown</a><details open="open"><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul class="current">
<li class="toctree-l2 current active"><a class="current reference internal" href="#">3.4. Here’s my sample title</a></li>
<li class="toctree-l2 current active"><a class="current reference internal" href="#">3.3.1. Here’s my sample title</a></li>
</ul>
</details></li>
</ul>
Expand Down Expand Up @@ -381,7 +381,7 @@ <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="#here-s-my-first-section">3.4.1. Here’s my first section</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#here-s-my-first-section">3.3.1.1. Here’s my first section</a></li>
</ul>
</nav>
</div>
Expand All @@ -394,10 +394,10 @@ <h2> Contents </h2>
<article class="bd-article">

<section class="tex2jax_ignore mathjax_ignore" id="here-s-my-sample-title">
<h1><span class="section-number">3.4. </span>Here’s my sample title<a class="headerlink" href="#here-s-my-sample-title" title="Link to this heading">#</a></h1>
<h1><span class="section-number">3.3.1. </span>Here’s my sample title<a class="headerlink" href="#here-s-my-sample-title" title="Link to this heading">#</a></h1>
<p>This is some sample text.</p>
<section id="here-s-my-first-section">
<span id="my-label"></span><h2><span class="section-number">3.4.1. </span>Here’s my first section<a class="headerlink" href="#here-s-my-first-section" title="Link to this heading">#</a></h2>
<span id="my-label"></span><h2><span class="section-number">3.3.1.1. </span>Here’s my first section<a class="headerlink" href="#here-s-my-first-section" title="Link to this heading">#</a></h2>
<p>Here is a <a class="reference internal" href="intro.html"><span class="std std-doc">reference to the intro</span></a>. Here is a reference to <a class="reference internal" href="#my-label"><span class="std std-ref">here’s my label</span></a>.</p>
<p>Here is my nifty citation <span id="id1">[<a class="reference internal" href="markdown.html#id8" title="Fernando Perez, Brian E Granger, and John D Hunter. Python: an ecosystem for scientific computing. Computing in Science \\&amp; Engineering, 13(2):13–21, 2011.">Perez <em>et al.</em>, 2011</a>]</span>.</p>
<p>Here are multiple citations <span id="id2">[<a class="reference internal" href="markdown.html#id4" title="Christopher Ramsay Holdgraf, Wendy de Heer, Brian N. Pasley, Jochem W. Rieger, Nathan Crone, Jack J. Lin, Robert T. Knight, and Frédéric E. Theunissen. Rapid tuning shifts in human auditory cortex enhance speech intelligibility. Nature Communications, 7(May):13654, 2016. URL: http://www.nature.com/doifinder/10.1038/ncomms13654, doi:10.1038/ncomms13654.">Holdgraf <em>et al.</em>, 2016</a>, <a class="reference internal" href="markdown.html#id8" title="Fernando Perez, Brian E Granger, and John D Hunter. Python: an ecosystem for scientific computing. Computing in Science \\&amp; Engineering, 13(2):13–21, 2011.">Perez <em>et al.</em>, 2011</a>]</span>!</p>
Expand Down Expand Up @@ -476,7 +476,7 @@ <h1><span class="section-number">3.4. </span>Here’s my sample title<a class="h
</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="#here-s-my-first-section">3.4.1. Here’s my first section</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#here-s-my-first-section">3.3.1.1. Here’s my first section</a></li>
</ul>
</nav></div>

Expand Down
2 changes: 1 addition & 1 deletion search.html
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@
<li class="toctree-l1"><a class="reference internal" href="markdown.html">1. Alternative name</a></li>
<li class="toctree-l1"><a class="reference internal" href="notebooks.html">2. Content with notebooks</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="markdown-notebooks.html">3. Notebooks with MyST Markdown</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l2"><a class="reference internal" href="mymarkdownfile.html">3.4. Here’s my sample title</a></li>
<li class="toctree-l2"><a class="reference internal" href="mymarkdownfile.html">3.3.1. Here’s my sample title</a></li>
</ul>
</details></li>
</ul>
Expand Down
Loading

0 comments on commit a14204c

Please sign in to comment.