sforman
/
Thun
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Thun/docs
History
sforman 463ed04e05 Add grammar image. 
Made with https://jacquev6.github.io/DrawGrammar/
 		2023-09-06 18:24:27 -07:00
..
html Add grammar image. 2023-09-06 18:24:27 -07:00
misc Working on the notebooks. 2023-08-16 10:04:52 -07:00
notebooks Working on the docs. 2023-07-27 08:55:43 -07:00
reference Example of infra evaluation. 2023-08-26 10:56:29 -07:00
source Add grammar image. 2023-09-06 18:24:27 -07:00
Makefile Working on the docs. 2023-07-27 08:55:43 -07:00
OSDN-Makefile That doesn't go there. 2022-09-07 21:15:09 -07:00
README.md Add a README to the docs/ dir. 2023-08-30 07:26:47 -07:00
WhyScheme.md I think Scheme? 2023-08-31 10:42:29 -07:00
_joy_interpreter_flowchart_url.txt Add a flowchart for the interpreter. 2022-09-19 13:22:31 -07:00
build_index.py Working on the website for Thun. 2023-08-13 14:30:57 -07:00

README.md

Documentation for Thun

This directory contains the docs for Thun. It's kind of a mess right now (Aug 2023) but I'm working on it. Originally the docs took the form of a static website created with Sphinx (TODO: link to Sphinx project) and uploaded to OSDN (which provides a static site hosting service as part of your project there.) This was great, but recently I've been having little troubles with reaching OSDN. It seems weird to have issues in 2023 (Japan's not that far away?) but there it is.

Now I'm trying a simple collection of Markdown files which get converted to HTML by a simple Python script (the reference pages still use Pandoc.) I want to have a few pages covering Thun project itself, but most of the docs should be the notebooks and the function reference. (Some of the implementation languages have automatic doc generators and it might be nice to imclude those in the docs, but getting them all to look like each other might be bleah.)

Directory

  • build_index.py a crude script to convert Markdown to HTML
  • html/ output of the HTML creation process. Serve the contents of this directy.
  • _joy_interpreter_flowchart_url.txt This is the URL for the SVG flowchart image generator service.
  • Makefile uses build_index.py to convert source/ to html/.
  • notebooks/ The original Jupyter notebooks (*.ipynb files). I have a simple Joy kernel but I no longer know how to install and use it, so I'm converting these to Markdown files in the source/notebooks directory.
  • OSDN-Makefile The old make file for OSDN, took care of uploading.
  • reference/ The function reference docs. Some of these are out of date (e,g, some of the names of functions have changed.) There's a script to convert the separate per-function Markdown files into a single-page HTML file.
  • source/ The new source directory for generating the static site (in the html/ directory.)