Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
direnakkoc committed Mar 20, 2024
1 parent b80bb99 commit a937eb9
Show file tree
Hide file tree
Showing 9 changed files with 40 additions and 15 deletions.
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
# What is an academic OSPO?

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
1 change: 1 addition & 0 deletions genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -176,6 +176,7 @@
</li>
</ul>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="markdown.html">What is an academic OSPO?</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
8 changes: 5 additions & 3 deletions intro.html
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,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="Content with notebooks" href="notebooks.html" />
<link rel="next" title="What is an academic OSPO?" href="markdown.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
</head>
Expand Down Expand Up @@ -178,6 +178,7 @@
</li>
</ul>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="markdown.html">What is an academic OSPO?</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 @@ -442,6 +443,7 @@ <h2>Acknowledgements<a class="headerlink" href="#acknowledgements" title="Link t
This work is licensed under a Creative Commons Attribution 4.0 International License <a class="reference external" href="https://creativecommons.org/licenses/by/4.0/">(CC BY 4.0)</a>.</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="markdown.html">What is an academic OSPO?</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 @@ -480,11 +482,11 @@ <h2>Acknowledgements<a class="headerlink" href="#acknowledgements" title="Link t

<div class="prev-next-area">
<a class="right-next"
href="notebooks.html"
href="markdown.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">What is an academic OSPO?</p>
</div>
<i class="fa-solid fa-angle-right"></i>
</a>
Expand Down
1 change: 1 addition & 0 deletions markdown-notebooks.html
Original file line number Diff line number Diff line change
Expand Up @@ -176,6 +176,7 @@
</li>
</ul>
<ul class="current nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="markdown.html">What is an academic OSPO?</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>
</ul>
Expand Down
33 changes: 26 additions & 7 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; My sample book</title>
<title>What is an academic OSPO? &#8212; My sample book</title>



Expand Down Expand Up @@ -60,6 +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" href="intro.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
</head>
Expand Down Expand Up @@ -121,8 +123,6 @@





<div class="bd-sidebar-primary bd-sidebar">


Expand Down Expand Up @@ -176,7 +176,8 @@
</a>
</li>
</ul>
<ul class="nav bd-sidenav">
<ul class="current nav bd-sidenav">
<li class="toctree-l1 current active"><a class="current reference internal" href="#">What is an academic OSPO?</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 @@ -364,7 +365,7 @@


<div id="jb-print-docs-body" class="onlyprint">
<h1>Markdown Files</h1>
<h1>What is an academic OSPO?</h1>
<!-- Table of contents -->
<div id="print-main-content">
<div id="jb-print-toc">
Expand All @@ -389,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="what-is-an-academic-ospo">
<h1>What is an academic OSPO?<a class="headerlink" href="#what-is-an-academic-ospo" 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 Down Expand Up @@ -475,6 +476,24 @@ <h2>Learn more<a class="headerlink" href="#learn-more" title="Link to this headi
<footer class="prev-next-footer">

<div class="prev-next-area">
<a class="left-prev"
href="intro.html"
title="previous page">
<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</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>
</div>
<i class="fa-solid fa-angle-right"></i>
</a>
</div>
</footer>

Expand Down
7 changes: 4 additions & 3 deletions notebooks.html
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Notebooks with MyST Markdown" href="markdown-notebooks.html" />
<link rel="prev" title="Welcome" href="intro.html" />
<link rel="prev" title="What is an academic OSPO?" href="markdown.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
</head>
Expand Down Expand Up @@ -179,6 +179,7 @@
</li>
</ul>
<ul class="current nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="markdown.html">What is an academic OSPO?</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 @@ -505,12 +506,12 @@ <h2>Code blocks and outputs<a class="headerlink" href="#code-blocks-and-outputs"

<div class="prev-next-area">
<a class="left-prev"
href="intro.html"
href="markdown.html"
title="previous page">
<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</p>
<p class="prev-next-title">What is an academic OSPO?</p>
</div>
</a>
<a class="right-next"
Expand Down
Binary file modified objects.inv
Binary file not shown.
1 change: 1 addition & 0 deletions search.html
Original file line number Diff line number Diff line change
Expand Up @@ -178,6 +178,7 @@
</li>
</ul>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="markdown.html">What is an academic OSPO?</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: 1 addition & 1 deletion searchindex.js

Large diffs are not rendered by default.

0 comments on commit a937eb9

Please sign in to comment.