Commit Graph

241 Commits

Author SHA1 Message Date
Simon Forman ac56b0f03c Removing old html. 2018-06-08 13:22:13 -07:00
Simon Forman 0264efdda6 Rebuild html. 2018-06-08 13:17:36 -07:00
Simon Forman b98e9f2107 The Hylos notebook is not ready for public yet. 2018-06-08 13:05:59 -07:00
Simon Forman f5fe7d9726 Move notebook rst files to sphinx subdir.
Only for the ones that are already prepared.
2018-06-07 12:48:24 -07:00
Simon Forman abdece348f Spaces in filenames noooo. 2018-06-07 12:42:15 -07:00
Simon Forman 507d045a3d Cleaning up docs. 2018-06-07 12:37:32 -07:00
Simon Forman 956d849c8a Toplevel makefile docs target uses docs makefile. 2018-06-06 13:33:04 -07:00
Simon Forman 989e48c155 Only (re)make changed notebooks.
I love make.  (Despite not working with spaces in filenames, since that's
a dumbass thing to do anyway.)  There's probably a better way to do what
I did but it works so I'm happy.
2018-06-06 13:27:51 -07:00
Simon Forman d050180b88 Some docs that got swept up in the commotion. 2018-06-06 13:08:04 -07:00
Simon Forman 36b770f000 Make hates spaces in file names. 2018-06-06 13:07:31 -07:00
Simon Forman 81919c4bbe Make cannot deal with spaces in filenames.
Is make wrong, or is it your filename?
2018-06-06 12:57:12 -07:00
Simon Forman 8a0a5e9f30 I want to re-make only edited notebooks.
Not all of them each time.
2018-06-06 12:48:16 -07:00
Simon Forman 09276fdc13 Bunch of minor docs edits. 2018-06-06 12:47:11 -07:00
Simon Forman 3fb1e0ea81 Minor docs edit. 2018-06-06 11:45:33 -07:00
Simon Forman c60d54d009 Minor docs edits. 2018-06-06 11:32:19 -07:00
Simon Forman 637d4efa6a Minor docs cleanup. 2018-06-06 11:20:31 -07:00
Simon Forman 0de5029c98 Bumped version to 0.2.0; docs edits.
I've added cond and cmp to the library so that should bump the minor
version no. I think.
2018-06-06 08:47:26 -07:00
Simon Forman 22f7c6da00 Minor docs edits. 2018-06-06 07:59:06 -07:00
Simon Forman be6387f1f6 Regenerated docs. 2018-06-05 17:41:22 -07:00
Simon Forman 9a04534b05 More docs. 2018-06-05 17:39:18 -07:00
Simon Forman e67a6f7b6e Working on tree docs. 2018-05-29 11:38:58 -07:00
Simon Forman aafecdc035 Editing Trees; implemented BTree-Delete. 2018-05-08 08:34:20 -07:00
Simon Forman c3a3f5a527 Still working towards v0.1.1 docs. 2018-05-01 08:41:39 -07:00
Simon Forman 04e8f70dd2 More docs changes. 2018-04-30 10:12:56 -07:00
Simon Forman f3b72b1938 Missed the notebooks *.html files. 2018-04-28 09:30:47 -07:00
Simon Forman 946d920cad More docs
Working towards that v0.1.1.
2018-04-28 09:10:47 -07:00
Simon Forman aabe19036f Still working towards v0.1.1.
The next "patch" bump is almost all docs.
2018-04-27 12:08:46 -07:00
Simon Forman 7aa8580ee3 Working on docs. 2018-04-26 11:47:55 -07:00
Simon Forman 8dc629cbd5 Remove a couple of docs.
One redundant the other unneeded.
2018-04-26 07:02:22 -07:00
Simon Forman 327548d715 Notebooks in Sphinx?
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.
2018-04-26 07:00:36 -07:00
Simon Forman aac5a42cab Somehow these didn't get added earlier. 2018-04-25 20:55:26 -07:00
Simon Forman 6797497453 Bump version to 0.1.1
To cover the docs updates and such.
2018-04-25 20:53:59 -07:00
Simon Forman 59c15956fa Include Sphinx-built HTML. 2018-04-25 13:57:23 -07:00
Simon Forman 2887132aeb Editing Sphinx docs.
A lot more still to do but it's coming along.
2018-04-25 13:35:03 -07:00
Simon Forman cfbd9a5182 ReST docs & library edits for Sphinx
Used Pandoc to convert the notebooks to rst format.  Used 2to3 to edit
the function signatures that were causing sphinx to error out.  Am I
really the only one who uses that syntax?
2018-04-24 22:07:21 -07:00
Simon Forman 147641611d Working on the Sphinx docs.
I had to remove the tuples from the args specs, sphinx had kittens.

I see value both in the autodoc for library.py and the library examples
Jupyter notebook (converted to ReST format) so I'm including them both.

Calling the library module autodocs the "Function Reference".
2018-04-24 21:01:16 -07:00
Simon Forman 93b35593d4 Sphinx docs coming along.
It's so pretty!  Make me want to write more docs.  :-)

Some weird bug parsing the library.py module though.  D'oh!
2018-04-22 22:44:49 -07:00
Simon Forman 2d617a2588 Messing with Sphinx. 2018-04-22 18:26:20 -07:00
Simon Forman a2be822703 Let's try Sphinx... 2018-04-22 15:28:40 -07:00
Simon Forman 669c86cbf1 Change project name to Thun.
I waited too long to upload to PyPI and some other bastard snagged the name.  I originally wanted to call it "Thun" as a tribute to Manfred von Thun, but I was concerned that this might seem to violate the thrid clause in the license of the original Joy code, to wit:

3. The name of the author may not be used to endorse or promote products  derived from this software without specific prior written permission.

Since the author is deceased I don't know of whom to ask permission to call this project Thun, but since I am not trying to "endorse or promote" this project with his name it should be alright.  In any event if anyone complains I can rename the project again.
2018-04-21 21:26:41 -07:00
Simon Forman beb7155b4a Initial move of code from git repo. 2018-04-14 18:13:13 -07:00