Commit Graph

8 Commits

Author SHA1 Message Date
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