sforman/Thun
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Notebooks in Sphinx?

Browse Source 
Converting the notebooks to ReST with nbconvert, then using sphinx on the
.rst files gives a pretty decent effect, except that the title levels are
off a little.

I need to look into hosting for the notebooks, maybe on MS Azure.  In the
meantime, I prefer the HTML made by Sphinx to the HTML made by nbconvert
directly.  It has index and cross refs and the code blocks scroll
horizontally which is crucial for wide Joy traces.  And Garamond.  God
bless Garamond.

For the Sphinx docs I'm going to edit the notebook ReST files by hand,
diverging from the originals.
This commit is contained in:
Simon Forman
2018-04-26 07:00:36 -07:00
parent aac5a42cab
commit 327548d715
38 changed files with 11708 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/sphinx_docs/_build/html/_modules/index.html
+1 -1
View File
@@ -6,7 +6,7 @@
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Overview: module code &#8212; Thun 0.1.0 documentation</title>
<title>Overview: module code &#8212; Thun 0.1.1 documentation</title>
<link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript" src="../_static/documentation_options.js"></script>
docs/sphinx_docs/_build/html/_modules/joy/joy.html
+1 -1
View File
@@ -6,7 +6,7 @@
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>joy.joy &#8212; Thun 0.1.0 documentation</title>
<title>joy.joy &#8212; Thun 0.1.1 documentation</title>
<link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<script type="text/javascript" src="../../_static/documentation_options.js"></script>
docs/sphinx_docs/_build/html/_modules/joy/library.html
+1 -1
View File
@@ -6,7 +6,7 @@
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>joy.library &#8212; Thun 0.1.0 documentation</title>
<title>joy.library &#8212; Thun 0.1.1 documentation</title>
<link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<script type="text/javascript" src="../../_static/documentation_options.js"></script>
docs/sphinx_docs/_build/html/_modules/joy/parser.html
+1 -1
View File
@@ -6,7 +6,7 @@
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>joy.parser &#8212; Thun 0.1.0 documentation</title>
<title>joy.parser &#8212; Thun 0.1.1 documentation</title>
<link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<script type="text/javascript" src="../../_static/documentation_options.js"></script>
docs/sphinx_docs/_build/html/_modules/joy/utils/pretty_print.html
+1 -1
View File
@@ -6,7 +6,7 @@
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>joy.utils.pretty_print &#8212; Thun 0.1.0 documentation</title>
<title>joy.utils.pretty_print &#8212; Thun 0.1.1 documentation</title>
<link rel="stylesheet" href="../../../_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<script type="text/javascript" src="../../../_static/documentation_options.js"></script>
docs/sphinx_docs/_build/html/_modules/joy/utils/stack.html
+1 -1
View File
@@ -6,7 +6,7 @@
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>joy.utils.stack &#8212; Thun 0.1.0 documentation</title>
<title>joy.utils.stack &#8212; Thun 0.1.1 documentation</title>
<link rel="stylesheet" href="../../../_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<script type="text/javascript" src="../../../_static/documentation_options.js"></script>
docs/sphinx_docs/_build/html/_sources/index.rst.txt
+2 -2
View File
@@ -6,7 +6,7 @@
Thun |release| Documentation
============================
Thun is dialect of Joy written in Python.
Thun is dialect of Joy written in Python 2.
`Joy`_ is a programming language created by Manfred von Thun that is easy to
use and understand and has many other nice properties. This Python
@@ -75,7 +75,7 @@ interesting aspects. It's quite a treasure trove.
Documentation on Thun Dialect
-----------------------------
Thun is implemented in Python. The following is specific information for this dialect of Joy.
The following is specific information for this dialect of Joy.
There are also some Jupyter notebooks.
.. toctree::
docs/sphinx_docs/_build/html/_static/documentation_options.js
+1 -1
View File
@@ -1,6 +1,6 @@
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '0.1.0',
VERSION: '0.1.1',
LANGUAGE: 'None',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
docs/sphinx_docs/_build/html/genindex.html
+1 -1
View File
@@ -7,7 +7,7 @@
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Index &#8212; Thun 0.1.0 documentation</title>
<title>Index &#8212; Thun 0.1.1 documentation</title>
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript" src="_static/documentation_options.js"></script>
docs/sphinx_docs/_build/html/index.html
+5 -5
View File
@@ -6,7 +6,7 @@
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Thun 0.1.0 Documentation &#8212; Thun 0.1.0 documentation</title>
<title>Thun 0.1.1 Documentation &#8212; Thun 0.1.1 documentation</title>
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript" src="_static/documentation_options.js"></script>
@@ -32,8 +32,8 @@
<div class="body" role="main">
<div class="section" id="thun-release-documentation">
<h1>Thun 0.1.0 Documentation<a class="headerlink" href="#thun-release-documentation" title="Permalink to this headline"></a></h1>
<p>Thun is dialect of Joy written in Python.</p>
<h1>Thun 0.1.1 Documentation<a class="headerlink" href="#thun-release-documentation" title="Permalink to this headline"></a></h1>
<p>Thun is dialect of Joy written in Python 2.</p>
<p><a class="reference external" href="https://en.wikipedia.org/wiki/Joy_(programming_language)">Joy</a> is a programming language created by Manfred von Thun that is easy to
use and understand and has many other nice properties. This Python
package implements an interpreter for a dialect of Joy that attempts to
@@ -79,7 +79,7 @@ interesting aspects. It’s quite a treasure trove.</p>
</div>
<div class="section" id="documentation-on-thun-dialect">
<h2>Documentation on Thun Dialect<a class="headerlink" href="#documentation-on-thun-dialect" title="Permalink to this headline"></a></h2>
<p>Thun is implemented in Python. The following is specific information for this dialect of Joy.
<p>The following is specific information for this dialect of Joy.
There are also some Jupyter notebooks.</p>
<div class="toctree-wrapper compound">
<ul>
@@ -135,7 +135,7 @@ There are also some Jupyter notebooks.</p>
<div class="sphinxsidebarwrapper">
<h3><a href="#">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Thun 0.1.0 Documentation</a><ul>
<li><a class="reference internal" href="#">Thun 0.1.1 Documentation</a><ul>
<li><a class="reference internal" href="#quick-start">Quick Start</a></li>
<li><a class="reference internal" href="#project-hosted-on-osdn">Project Hosted on OSDN</a></li>
<li><a class="reference internal" href="#information-on-the-joy-language">Information on the Joy language</a></li>
docs/sphinx_docs/_build/html/joy.html
+3 -3
View File
@@ -6,7 +6,7 @@
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Joy Interpreter &#8212; Thun 0.1.0 documentation</title>
<title>Joy Interpreter &#8212; Thun 0.1.1 documentation</title>
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript" src="_static/documentation_options.js"></script>
@@ -17,7 +17,7 @@
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Stack or Quote or Sequence or List…" href="stack.html" />
<link rel="prev" title="Thun 0.1.0 Documentation" href="index.html" />
<link rel="prev" title="Thun 0.1.1 Documentation" href="index.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
@@ -96,7 +96,7 @@ executed.</p>
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li>Previous: <a href="index.html" title="previous chapter">Thun 0.1.0 Documentation</a></li>
<li>Previous: <a href="index.html" title="previous chapter">Thun 0.1.1 Documentation</a></li>
<li>Next: <a href="stack.html" title="next chapter">Stack or Quote or Sequence or List…</a></li>
</ul></li>
</ul>
docs/sphinx_docs/_build/html/lib.html
+1 -1
View File
@@ -6,7 +6,7 @@
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Functions Grouped by, er, Function with Examples &#8212; Thun 0.1.0 documentation</title>
<title>Functions Grouped by, er, Function with Examples &#8212; Thun 0.1.1 documentation</title>
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript" src="_static/documentation_options.js"></script>
docs/sphinx_docs/_build/html/library.html
+3 -3
View File
@@ -6,7 +6,7 @@
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Function Reference &#8212; Thun 0.1.0 documentation</title>
<title>Function Reference &#8212; Thun 0.1.1 documentation</title>
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript" src="_static/documentation_options.js"></script>
@@ -16,7 +16,7 @@
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Examples (and some documentation) for the Words in the Library" href="lib.html" />
<link rel="next" title="Functions Grouped by, er, Function with Examples" href="lib.html" />
<link rel="prev" title="Tracing Joy Execution" href="pretty.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
@@ -800,7 +800,7 @@ from each list. The smallest list sets the length of the result list.</p>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li>Previous: <a href="pretty.html" title="previous chapter">Tracing Joy Execution</a></li>
<li>Next: <a href="lib.html" title="next chapter">Examples (and some documentation) for the Words in the Library</a></li>
<li>Next: <a href="lib.html" title="next chapter">Functions Grouped by, er, Function with Examples</a></li>
</ul></li>
</ul>
</div>
docs/sphinx_docs/_build/html/objects.inv
BIN
View File
Binary file not shown.
docs/sphinx_docs/_build/html/parser.html
+1 -1
View File
@@ -6,7 +6,7 @@
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Parsing Text into Joy Expressions &#8212; Thun 0.1.0 documentation</title>
<title>Parsing Text into Joy Expressions &#8212; Thun 0.1.1 documentation</title>
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript" src="_static/documentation_options.js"></script>
docs/sphinx_docs/_build/html/pretty.html
+1 -1
View File
@@ -6,7 +6,7 @@
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Tracing Joy Execution &#8212; Thun 0.1.0 documentation</title>
<title>Tracing Joy Execution &#8212; Thun 0.1.1 documentation</title>
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript" src="_static/documentation_options.js"></script>
docs/sphinx_docs/_build/html/py-modindex.html
+1 -1
View File
@@ -6,7 +6,7 @@
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Python Module Index &#8212; Thun 0.1.0 documentation</title>
<title>Python Module Index &#8212; Thun 0.1.1 documentation</title>
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript" src="_static/documentation_options.js"></script>
docs/sphinx_docs/_build/html/search.html
+1 -1
View File
@@ -6,7 +6,7 @@
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Search &#8212; Thun 0.1.0 documentation</title>
<title>Search &#8212; Thun 0.1.1 documentation</title>
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript" src="_static/documentation_options.js"></script>
docs/sphinx_docs/_build/html/searchindex.js
+1 -1
View File
File diff suppressed because one or more lines are too long
docs/sphinx_docs/_build/html/stack.html
+1 -1
View File
@@ -6,7 +6,7 @@
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Stack or Quote or Sequence or List… &#8212; Thun 0.1.0 documentation</title>
<title>Stack or Quote or Sequence or List… &#8212; Thun 0.1.1 documentation</title>
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript" src="_static/documentation_options.js"></script>