From 0a1b150eb5fca4b2ee3828c44ad1f558a5ed2b2b Mon Sep 17 00:00:00 2001 From: sforman Date: Thu, 27 Jul 2023 08:55:43 -0700 Subject: [PATCH] Working on the docs. The nbconvert tool has different behaviour now, so the HTML versions of the notebooks look different. --- docs/Makefile | 24 +- docs/html/index.html | 10 +- ..._This_Implementation_of_Joy_in_Python.html | 27520 ++++++------- .../1._Basic_Use_of_Joy_in_a_Notebook.html | 27115 ++++++------- docs/html/notebooks/2._Library_Examples.html | 32807 +++++++--------- .../notebooks/3._Developing_a_Program.html | 28667 +++++++------- .../Advent_of_Code_2017_December_1st.html | 27543 ++++++------- .../Advent_of_Code_2017_December_2nd.html | 27935 ++++++------- .../Advent_of_Code_2017_December_3rd.html | 28406 +++++++------ .../Advent_of_Code_2017_December_4th.html | 27034 ++++++------- .../Advent_of_Code_2017_December_5th.html | 27272 ++++++------- .../Advent_of_Code_2017_December_6th.html | 27461 ++++++------- docs/html/notebooks/BigInts.html | 13369 ++++++- docs/html/notebooks/Compiling_Joy.html | 28374 +++++++------ docs/html/notebooks/Correcet_Programming.html | 32571 +++++++-------- .../Derivatives_of_Regular_Expressions.html | 27900 ++++++------- docs/html/notebooks/Generator_Programs.html | 28398 +++++++------ ...ara-morphisms_-_Recursion_Combinators.html | 28073 +++++++------ docs/html/notebooks/Intro-to-Joy.html | 13308 +++++++ docs/html/notebooks/Joy-in-Jupyter.html | 27330 ++++++------- docs/html/notebooks/Multiples-of-3-and-5.html | 29125 +++++++------- docs/html/notebooks/NeoAero.html | 13172 +++++++ docs/html/notebooks/Newton-Raphson.html | 27928 ++++++------- docs/html/notebooks/Ordered_Binary_Trees.html | 29458 +++++++------- docs/html/notebooks/Quadratic.html | 27162 ++++++------- .../html/notebooks/Recursion_Combinators.html | 28999 +++++++------- docs/html/notebooks/Remove-Function.html | 27461 ++++++------- docs/html/notebooks/Replacing.html | 27060 ++++++------- docs/html/notebooks/Square_Spiral.html | 28258 +++++++------ docs/html/notebooks/The_Four_Operations.html | 27107 ++++++------- docs/html/notebooks/Trees.html | 30022 +++++++------- docs/html/notebooks/Treestep.html | 28123 +++++++------ docs/html/notebooks/TypeChecking.html | 27298 ++++++------- docs/html/notebooks/Types.html | 31049 +++++++-------- docs/html/notebooks/Zipper.html | 27626 ++++++------- docs/html/notebooks/fun_with_scan.html | 27427 ++++++------- docs/html/notebooks/index.html | 4 + docs/html/notebooks/with_sympy.html | 28758 +++++++------- docs/{ => misc}/talk.md | 0 docs/{ => misc}/trace.txt | 0 docs/notebooks/Makefile | 4 +- docs/notebooks/build_index.py | 1 + docs/source/index.md | 10 +- 43 files changed, 463841 insertions(+), 483328 deletions(-) create mode 100644 docs/html/notebooks/Intro-to-Joy.html create mode 100644 docs/html/notebooks/NeoAero.html rename docs/{ => misc}/talk.md (100%) rename docs/{ => misc}/trace.txt (100%) diff --git a/docs/Makefile b/docs/Makefile index b857eaf..cec86ee 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -1,16 +1,16 @@ # Docs toplevel makefile. -README=./source/index.md -BUILD_SCRIPT=build_index.py -GENERATOR=python $(BUILD_SCRIPT) -HTML_OUTPUT_DIR=./html -NOTEBOOK_OUTPUT_DIR=$(HTML_OUTPUT_DIR)/notebooks +INDEX = ./source/index.md +BUILD_SCRIPT = build_index.py +GENERATOR = python $(BUILD_SCRIPT) +HTML_OUTPUT_DIR = ./html +NOTEBOOK_OUTPUT_DIR = $(HTML_OUTPUT_DIR)/notebooks +INDEX_OUT = $(HTML_OUTPUT_DIR)/index.html + +all: $(INDEX_OUT) + +$(INDEX_OUT): $(INDEX) $(BUILD_SCRIPT) + $(GENERATOR) $(INDEX) > $(INDEX_OUT) -all: $(HTML_OUTPUT_DIR)/index.html - -$(HTML_OUTPUT_DIR)/index.html: $(README) $(BUILD_SCRIPT) - $(GENERATOR) $(README) > $(HTML_OUTPUT_DIR)/index.html - - -# python -m markdown -f index.html -o html $(README) +# python -m markdown -f index.html -o html $(INDEX) diff --git a/docs/html/index.html b/docs/html/index.html index 7c3968c..bf511ec 100644 --- a/docs/html/index.html +++ b/docs/html/index.html @@ -49,7 +49,7 @@ interesting aspects. It's quite a treasure trove.

two integers and increments or decrements one of them such that the new pair of numbers is the next coordinate pair in a square spiral (like the kind used to construct an Ulam Spiral). -For more information see Square Spiral Example Joy Code.

+For more information see Square Spiral Example Joy Code.

square_spiral [_p] [_then] [_else] ifte
 
 _p  [_p0] [_p1] &&
@@ -71,13 +71,13 @@ _else [pop !-]  [--]   [++]  ifte
 
 

Documentation

This document describes Joy in a general way below, however most of the -documentation is in the form of Jupyter Notebooks +documentation is in the form of Jupyter Notebooks that go into more detail.

-

Jupyter Notebooks

-

There's also a Function Reference that lists each +

Jupyter Notebooks

+

There's also a Function Reference that lists each function and combinator by name and gives a brief description. (It's usually out of date, I'm working on it.)

-

Function Reference

+

Function Reference

Building the Docs

Run make in the docs directory. (This is a lie, it's more complex than that. Really you need to run (GNU) make in the docs/notebooks and diff --git a/docs/html/notebooks/0._This_Implementation_of_Joy_in_Python.html b/docs/html/notebooks/0._This_Implementation_of_Joy_in_Python.html index f55bf84..b61401c 100644 --- a/docs/html/notebooks/0._This_Implementation_of_Joy_in_Python.html +++ b/docs/html/notebooks/0._This_Implementation_of_Joy_in_Python.html @@ -3,12624 +3,11322 @@ -0._This_Implementation_of_Joy_in_Python - - - +0._This_Implementation_of_Joy_in_Python - - - - + - - + - + +

+
-
- -