Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
abikesa committed Jun 7, 2024
1 parent 222dacc commit 30aea64
Show file tree
Hide file tree
Showing 16 changed files with 133 additions and 105 deletions.
2 changes: 1 addition & 1 deletion .buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: b1f3a2540a36d17d5ef503e82b51fed3
config: 1f70cafc8b321e5da37edf824eab2774
tags: 645f666f9bcd5a90fca523b33c5a78b7
38 changes: 38 additions & 0 deletions _downloads/495e8ed6d7bc3b66ca278c92fbf07ef9/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
<!--
1. right click on webApp, choose inspect element, collapse & analyze code
2. study .HTML code-block, say, <canvas id="mortality-risk-graph"></canvas>
3. find corresponding "id" in .js, "mortality-risk-graph" in this case
4. collapse .HTML code-block and proceed to another, say, prior <div></div>
5. this will be the systematic approach for the autodidact :)
-->
<!DOCTYPE html>
<html lang="en">

<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Mortality Risk Calculator</title>
</head>

<body>
<div>
<label for="scenario-dropdown">Select Scenario:</label>
<select id="scenario-dropdown">
<option value="excellent">Excellent</option>
<option value="verygood">Very Good</option>
<option value="good">Good</option>
<option value="fair">Fair</option>
<option value="poor">Poor</option>
</select>
<button id="calculate-risk-button">Calculate Mortality Risk</button>
</div>
<!-- <div id="mortality-risk-results"></div> ; the interactive graphics do it all :) -->
<div style="width: 80vw; margin: 0 auto;">
<canvas id="mortality-risk-graph" width="400" height="400"></canvas>
</div>
<script src="https://cdn.jsdelivr.net/npm/chart.js"></script>
<script src="./assets/js/script.js"></script>
</body>

</html>
9 changes: 2 additions & 7 deletions _sources/intro.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,6 @@
# Welcome to your Jupyter Book
# Vector

This is a small sample book to give you a feel for how book content is
structured.
It shows off a few of the major file types, as well as some sample content.
It does not go in-depth into any particular topic - check out [the Jupyter Book documentation](https://jupyterbook.org) for more information.

Check out the content pages bundled with this sample book to see more.


```{tableofcontents}
```
8 changes: 4 additions & 4 deletions _sources/markdown-notebooks.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@ kernelspec:
name: python3
---

# Notebooks with MyST Markdown
![](https://matrix4humans.com/wp-content/uploads/2020/02/matrix-keymaker.png)

Jupyter Book also lets you write text-based notebooks using MyST Markdown.
See [the Notebooks with MyST Markdown documentation](https://jupyterbook.org/file-types/myst-notebooks.html) for more detailed instructions.
This page shows off a notebook written in MyST Markdown.
# MyST

Let's try to embed it [here](./quickdeploy/index.html)

## An example cell

Expand Down
2 changes: 1 addition & 1 deletion _sources/markdown.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Markdown Files
# Bibliography

Whether you write your book's content in Jupyter Notebooks (`.ipynb`) or
in regular markdown files (`.md`), you'll write in the same flavor of markdown
Expand Down
2 changes: 1 addition & 1 deletion _sources/notebooks.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"# Content with notebooks\n",
"# Notebook\n",
"\n",
"You can also create content with Jupyter Notebooks. This means that you can include\n",
"code blocks and their outputs in your book.\n",
Expand Down
12 changes: 6 additions & 6 deletions genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -149,8 +149,8 @@



<img src="https://www.apa.org/images/2020-09-exposing-secrets_tcm7-277839.jpg" class="logo__image only-light" alt="Nodes, Edges, Vastness - Home"/>
<script>document.write(`<img src="https://www.apa.org/images/2020-09-exposing-secrets_tcm7-277839.jpg" class="logo__image only-dark" alt="Nodes, Edges, Vastness - Home"/>`);</script>
<img src="https://www.gavi.org/sites/default/files/2020-11/viral-thumb.jpg" class="logo__image only-light" alt="Nodes, Edges, Vastness - Home"/>
<script>document.write(`<img src="https://www.gavi.org/sites/default/files/2020-11/viral-thumb.jpg" class="logo__image only-dark" alt="Nodes, Edges, Vastness - Home"/>`);</script>


</a></div>
Expand All @@ -171,14 +171,14 @@
<ul class="nav bd-sidenav bd-sidenav__home-link">
<li class="toctree-l1">
<a class="reference internal" href="intro.html">
Welcome to your Jupyter Book
Vector
</a>
</li>
</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>
<li class="toctree-l1"><a class="reference internal" href="markdown.html">Bibliography</a></li>
<li class="toctree-l1"><a class="reference internal" href="notebooks.html">Notebook</a></li>
<li class="toctree-l1"><a class="reference internal" href="markdown-notebooks.html">MyST</a></li>
</ul>

</div>
Expand Down
35 changes: 15 additions & 20 deletions intro.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>Welcome to your Jupyter Book &#8212; Nodes, Edges, Vastness</title>
<title>Vector &#8212; Nodes, Edges, Vastness</title>



Expand Down Expand Up @@ -62,7 +62,7 @@
<script>DOCUMENTATION_OPTIONS.pagename = 'intro';</script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Markdown Files" href="markdown.html" />
<link rel="next" title="Bibliography" href="markdown.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
</head>
Expand Down Expand Up @@ -153,8 +153,8 @@



<img src="https://www.apa.org/images/2020-09-exposing-secrets_tcm7-277839.jpg" class="logo__image only-light" alt="Nodes, Edges, Vastness - Home"/>
<script>document.write(`<img src="https://www.apa.org/images/2020-09-exposing-secrets_tcm7-277839.jpg" class="logo__image only-dark" alt="Nodes, Edges, Vastness - Home"/>`);</script>
<img src="https://www.gavi.org/sites/default/files/2020-11/viral-thumb.jpg" class="logo__image only-light" alt="Nodes, Edges, Vastness - Home"/>
<script>document.write(`<img src="https://www.gavi.org/sites/default/files/2020-11/viral-thumb.jpg" class="logo__image only-dark" alt="Nodes, Edges, Vastness - Home"/>`);</script>


</a></div>
Expand All @@ -175,14 +175,14 @@
<ul class="nav bd-sidenav bd-sidenav__home-link">
<li class="toctree-l1 current active">
<a class="reference internal" href="#">
Welcome to your Jupyter Book
Vector
</a>
</li>
</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>
<li class="toctree-l1"><a class="reference internal" href="markdown.html">Bibliography</a></li>
<li class="toctree-l1"><a class="reference internal" href="notebooks.html">Notebook</a></li>
<li class="toctree-l1"><a class="reference internal" href="markdown-notebooks.html">MyST</a></li>
</ul>

</div>
Expand Down Expand Up @@ -366,7 +366,7 @@


<div id="jb-print-docs-body" class="onlyprint">
<h1>Welcome to your Jupyter Book</h1>
<h1>Vector</h1>
<!-- Table of contents -->
<div id="print-main-content">
<div id="jb-print-toc">
Expand All @@ -380,18 +380,13 @@ <h1>Welcome to your Jupyter Book</h1>
<div id="searchbox"></div>
<article class="bd-article">

<section class="tex2jax_ignore mathjax_ignore" id="welcome-to-your-jupyter-book">
<h1>Welcome to your Jupyter Book<a class="headerlink" href="#welcome-to-your-jupyter-book" title="Link to this heading">#</a></h1>
<p>This is a small sample book to give you a feel for how book content is
structured.
It shows off a few of the major file types, as well as some sample content.
It does not go in-depth into any particular topic - check out <a class="reference external" href="https://jupyterbook.org">the Jupyter Book documentation</a> for more information.</p>
<p>Check out the content pages bundled with this sample book to see more.</p>
<section class="tex2jax_ignore mathjax_ignore" id="vector">
<h1>Vector<a class="headerlink" href="#vector" title="Link to this heading">#</a></h1>
<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>
<li class="toctree-l1"><a class="reference internal" href="markdown.html">Bibliography</a></li>
<li class="toctree-l1"><a class="reference internal" href="notebooks.html">Notebook</a></li>
<li class="toctree-l1"><a class="reference internal" href="markdown-notebooks.html">MyST</a></li>
</ul>
</div>
</section>
Expand Down Expand Up @@ -431,7 +426,7 @@ <h1>Welcome to your Jupyter Book<a class="headerlink" href="#welcome-to-your-jup
title="next page">
<div class="prev-next-info">
<p class="prev-next-subtitle">next</p>
<p class="prev-next-title">Markdown Files</p>
<p class="prev-next-title">Bibliography</p>
</div>
<i class="fa-solid fa-angle-right"></i>
</a>
Expand Down
29 changes: 14 additions & 15 deletions markdown-notebooks.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>Notebooks with MyST Markdown &#8212; Nodes, Edges, Vastness</title>
<title>MyST &#8212; Nodes, Edges, Vastness</title>



Expand Down 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="prev" title="Content with notebooks" href="notebooks.html" />
<link rel="prev" title="Notebook" href="notebooks.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
</head>
Expand Down Expand Up @@ -149,8 +149,8 @@



<img src="https://www.apa.org/images/2020-09-exposing-secrets_tcm7-277839.jpg" class="logo__image only-light" alt="Nodes, Edges, Vastness - Home"/>
<script>document.write(`<img src="https://www.apa.org/images/2020-09-exposing-secrets_tcm7-277839.jpg" class="logo__image only-dark" alt="Nodes, Edges, Vastness - Home"/>`);</script>
<img src="https://www.gavi.org/sites/default/files/2020-11/viral-thumb.jpg" class="logo__image only-light" alt="Nodes, Edges, Vastness - Home"/>
<script>document.write(`<img src="https://www.gavi.org/sites/default/files/2020-11/viral-thumb.jpg" class="logo__image only-dark" alt="Nodes, Edges, Vastness - Home"/>`);</script>


</a></div>
Expand All @@ -171,14 +171,14 @@
<ul class="nav bd-sidenav bd-sidenav__home-link">
<li class="toctree-l1">
<a class="reference internal" href="intro.html">
Welcome to your Jupyter Book
Vector
</a>
</li>
</ul>
<ul class="current 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 current active"><a class="current reference internal" href="#">Notebooks with MyST Markdown</a></li>
<li class="toctree-l1"><a class="reference internal" href="markdown.html">Bibliography</a></li>
<li class="toctree-l1"><a class="reference internal" href="notebooks.html">Notebook</a></li>
<li class="toctree-l1 current active"><a class="current reference internal" href="#">MyST</a></li>
</ul>

</div>
Expand Down Expand Up @@ -364,7 +364,7 @@


<div id="jb-print-docs-body" class="onlyprint">
<h1>Notebooks with MyST Markdown</h1>
<h1>MyST</h1>
<!-- Table of contents -->
<div id="print-main-content">
<div id="jb-print-toc">
Expand All @@ -388,11 +388,10 @@ <h2> Contents </h2>
<div id="searchbox"></div>
<article class="bd-article">

<section class="tex2jax_ignore mathjax_ignore" id="notebooks-with-myst-markdown">
<h1>Notebooks with MyST Markdown<a class="headerlink" href="#notebooks-with-myst-markdown" title="Link to this heading">#</a></h1>
<p>Jupyter Book also lets you write text-based notebooks using MyST Markdown.
See <a class="reference external" href="https://jupyterbook.org/file-types/myst-notebooks.html">the Notebooks with MyST Markdown documentation</a> for more detailed instructions.
This page shows off a notebook written in MyST Markdown.</p>
<p><img alt="" src="https://matrix4humans.com/wp-content/uploads/2020/02/matrix-keymaker.png" /></p>
<section class="tex2jax_ignore mathjax_ignore" id="myst">
<h1>MyST<a class="headerlink" href="#myst" title="Link to this heading">#</a></h1>
<p>Let’s try to embed it <a class="reference download internal" download="" href="_downloads/495e8ed6d7bc3b66ca278c92fbf07ef9/index.html"><span class="xref download myst">here</span></a></p>
<section id="an-example-cell">
<h2>An example cell<a class="headerlink" href="#an-example-cell" title="Link to this heading">#</a></h2>
<p>With MyST Markdown, you can define code cells with a directive like so:</p>
Expand Down Expand Up @@ -471,7 +470,7 @@ <h2>Quickly add YAML metadata for MyST Notebooks<a class="headerlink" href="#qui
<i class="fa-solid fa-angle-left"></i>
<div class="prev-next-info">
<p class="prev-next-subtitle">previous</p>
<p class="prev-next-title">Content with notebooks</p>
<p class="prev-next-title">Notebook</p>
</div>
</a>
</div>
Expand Down
30 changes: 15 additions & 15 deletions markdown.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>Markdown Files &#8212; Nodes, Edges, Vastness</title>
<title>Bibliography &#8212; Nodes, Edges, Vastness</title>



Expand Down Expand Up @@ -60,8 +60,8 @@
<script>DOCUMENTATION_OPTIONS.pagename = 'markdown';</script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Content with notebooks" href="notebooks.html" />
<link rel="prev" title="Welcome to your Jupyter Book" href="intro.html" />
<link rel="next" title="Notebook" href="notebooks.html" />
<link rel="prev" title="Vector" href="intro.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
</head>
Expand Down Expand Up @@ -150,8 +150,8 @@



<img src="https://www.apa.org/images/2020-09-exposing-secrets_tcm7-277839.jpg" class="logo__image only-light" alt="Nodes, Edges, Vastness - Home"/>
<script>document.write(`<img src="https://www.apa.org/images/2020-09-exposing-secrets_tcm7-277839.jpg" class="logo__image only-dark" alt="Nodes, Edges, Vastness - Home"/>`);</script>
<img src="https://www.gavi.org/sites/default/files/2020-11/viral-thumb.jpg" class="logo__image only-light" alt="Nodes, Edges, Vastness - Home"/>
<script>document.write(`<img src="https://www.gavi.org/sites/default/files/2020-11/viral-thumb.jpg" class="logo__image only-dark" alt="Nodes, Edges, Vastness - Home"/>`);</script>


</a></div>
Expand All @@ -172,14 +172,14 @@
<ul class="nav bd-sidenav bd-sidenav__home-link">
<li class="toctree-l1">
<a class="reference internal" href="intro.html">
Welcome to your Jupyter Book
Vector
</a>
</li>
</ul>
<ul class="current nav bd-sidenav">
<li class="toctree-l1 current active"><a class="current reference internal" href="#">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>
<li class="toctree-l1 current active"><a class="current reference internal" href="#">Bibliography</a></li>
<li class="toctree-l1"><a class="reference internal" href="notebooks.html">Notebook</a></li>
<li class="toctree-l1"><a class="reference internal" href="markdown-notebooks.html">MyST</a></li>
</ul>

</div>
Expand Down Expand Up @@ -365,7 +365,7 @@


<div id="jb-print-docs-body" class="onlyprint">
<h1>Markdown Files</h1>
<h1>Bibliography</h1>
<!-- Table of contents -->
<div id="print-main-content">
<div id="jb-print-toc">
Expand All @@ -390,8 +390,8 @@ <h2> Contents </h2>
<div id="searchbox"></div>
<article class="bd-article">

<section class="tex2jax_ignore mathjax_ignore" id="markdown-files">
<h1>Markdown Files<a class="headerlink" href="#markdown-files" title="Link to this heading">#</a></h1>
<section class="tex2jax_ignore mathjax_ignore" id="bibliography">
<h1>Bibliography<a class="headerlink" href="#bibliography" title="Link to this heading">#</a></h1>
<p>Whether you write your book’s content in Jupyter Notebooks (<code class="docutils literal notranslate"><span class="pre">.ipynb</span></code>) or
in regular markdown files (<code class="docutils literal notranslate"><span class="pre">.md</span></code>), you’ll write in the same flavor of markdown
called <strong>MyST Markdown</strong>.
Expand All @@ -418,7 +418,7 @@ <h2>Sample Roles and Directives<a class="headerlink" href="#sample-roles-and-dir
<p>Here is a note</p>
</div>
<p>It will be rendered in a special box when you build your book.</p>
<p>Here is an inline directive to refer to a document: <a class="reference internal" href="markdown-notebooks.html"><span class="doc">Notebooks with MyST Markdown</span></a>.</p>
<p>Here is an inline directive to refer to a document: <a class="reference internal" href="markdown-notebooks.html"><span class="doc">MyST</span></a>.</p>
</section>
<section id="citations">
<h2>Citations<a class="headerlink" href="#citations" title="Link to this heading">#</a></h2>
Expand Down Expand Up @@ -482,15 +482,15 @@ <h2>Learn more<a class="headerlink" href="#learn-more" title="Link to this headi
<i class="fa-solid fa-angle-left"></i>
<div class="prev-next-info">
<p class="prev-next-subtitle">previous</p>
<p class="prev-next-title">Welcome to your Jupyter Book</p>
<p class="prev-next-title">Vector</p>
</div>
</a>
<a class="right-next"
href="notebooks.html"
title="next page">
<div class="prev-next-info">
<p class="prev-next-subtitle">next</p>
<p class="prev-next-title">Content with notebooks</p>
<p class="prev-next-title">Notebook</p>
</div>
<i class="fa-solid fa-angle-right"></i>
</a>
Expand Down
Loading

0 comments on commit 30aea64

Please sign in to comment.