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

Cleaning up docs. 

Kinda...
This commit is contained in:
Simon Forman 2022-09-16 09:03:42 -07:00
parent 7a25eee481
commit 9de71c84bf
8 changed files with 2535 additions and 2636 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -32,14 +32,14 @@ interesting aspects. It's quite a treasure trove.
Here is an example of Joy code:
[ [[abs] ii <=]
[
[<>] [pop !-] ||
] &&
]
[[ !-] [[++]] [[--]] ifte dip]
[[pop !-] [--] [++] ifte ]
ifte
square_spiral ≡ [_p] [_then] [_else] ifte
_p ≡ [_p0] [_p1] &&
_p0 ≡ [abs] ii <=
_p1 ≡ [<>] [pop !-] ||
_then ≡ [ !-] [[++]] [[--]] ifte dip
_else ≡ [pop !-] [--] [++] ifte
It might seem unreadable but with a little familiarity it becomes just as legible as any other notation.
@ -97,9 +97,9 @@ coordinate pair in a square spiral (like the kind used to construct an
The docs/notebooks dir contains Jupyter notebooks, ... TODO
## Function Reference
### Function Reference
[Function Reference](/FR.html)
[Function Reference](/FuncRef.html)
### Building the Docs

2605
docs/html/FR.html
View File

File diff suppressed because it is too large Load Diff

2501
docs/html/FuncRef.html Normal file
View File

File diff suppressed because it is too large Load Diff

20
docs/html/index.html
View File

@ -33,14 +33,14 @@ Joy and its deeper facets as well as how to program in it and several
interesting aspects. It's quite a treasure trove.</p>
<h2>Example Code</h2>
<p>Here is an example of Joy code:</p>
<pre><code>[ [[abs] ii &lt;=]
[
[&lt;&gt;] [pop !-] ||
] &amp;&amp;
]
[[ !-] [[++]] [[--]] ifte dip]
[[pop !-] [--] [++] ifte ]
ifte
<pre><code>square_spiral ≡ [_p] [_then] [_else] ifte
_p ≡ [_p0] [_p1] &amp;&amp;
_p0 ≡ [abs] ii &lt;=
_p1 ≡ [&lt;&gt;] [pop !-] ||
_then ≡ [ !-] [[++]] [[--]] ifte dip
_else ≡ [pop !-] [--] [++] ifte
</code></pre>
<p>It might seem unreadable but with a little familiarity it becomes just as legible as any other notation.</p>
<p>This function accepts two integers on the stack and increments or
@ -88,8 +88,8 @@ coordinate pair in a square spiral (like the kind used to construct an
<h3>Jupyter Notebooks</h3>
<p><a href="/notebooks/index.html">Notebooks</a></p>
<p>The docs/notebooks dir contains Jupyter notebooks, ... TODO</p>
<h2>Function Reference</h2>
<p><a href="/FR.html">Function Reference</a></p>
<h3>Function Reference</h3>
<p><a href="/FuncRef.html">Function Reference</a></p>
<h3>Building the Docs</h3>
<p>Run <code>make</code> in the <code>docs</code> directory.</p>
<h2>Basics of Joy</h2>

2
docs/reference/grabN.md
View File

@ -4,7 +4,7 @@
Function
Expect a number on the top of the satck and put that many items from uner it onto a new list.
Expect a number on the top of the stack and [cons] that many items from under it onto a new list.
### Example

6
docs/reference/mkref/FuncRef.html
View File

@ -4,7 +4,7 @@
<meta charset="utf-8" />
<meta name="generator" content="pandoc" />
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
<title>Functor Reference</title>
<title>Function Reference</title>
<style>
html {
line-height: 1.5;
@ -151,7 +151,7 @@
</head>
<body>
<header id="title-block-header">
<h1 class="title">Functor Reference</h1>
<h1 class="title">Function Reference</h1>
</header>
<nav id="TOC" role="doc-toc">
<ul>
@ -1224,7 +1224,7 @@ a F a</code></pre>
<hr />
<h2 id="grabn">grabN</h2>
<p>Function</p>
<p>Expect a number on the top of the satck and put that many items from uner it onto a new list.</p>
<p>Expect a number on the top of the stack and <a href="#cons">cons</a> that many items from under it onto a new list.</p>
<h3 id="example-6">Example</h3>
<pre><code> a b c d e 3 grabN
-----------------------

2
docs/reference/mkref/Functor-Reference.md → docs/reference/mkref/Function-Reference.md
View File

@ -1756,7 +1756,7 @@ implementation-dependant.)
Function
Expect a number on the top of the satck and put that many items from uner it onto a new list.
Expect a number on the top of the stack and [cons] that many items from under it onto a new list.
### Example

15
docs/reference/mkref/Makefile
View File

@ -1,14 +1,17 @@
FUNCDOCS = $(wildcard ../*.md)
TITLE = --metadata title="Functor Reference"
TITLE = --metadata title="Function Reference"
TOC = --toc --toc-depth=2
all: mov
all: Functor-Reference.md
pandoc -s $(TOC) $(TITLE) --ascii Functor-Reference.md -o FuncRef.html
FuncRef.html: Function-Reference.md
pandoc -s $(TOC) $(TITLE) --ascii Function-Reference.md -o FuncRef.html
Functor-Reference.md: HEADER.md $(FUNCDOCS)
awk 'FNR==1 && NR > 1 {print ""}1' HEADER.md $(FUNCDOCS) > Functor-Reference.md
Function-Reference.md: HEADER.md $(FUNCDOCS)
awk 'FNR==1 && NR > 1 {print ""}1' HEADER.md $(FUNCDOCS) > Function-Reference.md
# https://stackoverflow.com/questions/8183191/concatenating-files-and-insert-new-line-in-between-files
# WTF would we do w/o the Internet? Know our tools well?
mov: FuncRef.html
cp -v $? ../../html/