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".
This commit is contained in:
@@ -24,7 +24,7 @@ copyright = u'2018, Simon Forman'
|
||||
author = u'Simon Forman'
|
||||
|
||||
# The short X.Y version
|
||||
version = u''
|
||||
version = u'0.1'
|
||||
# The full version, including alpha/beta/rc tags
|
||||
release = u'0.1.0'
|
||||
|
||||
|
||||
@@ -3,21 +3,44 @@
|
||||
You can adapt this file completely to your liking, but it should at least
|
||||
contain the root `toctree` directive.
|
||||
|
||||
Thun Documentation
|
||||
==================
|
||||
Thun |release| Documentation
|
||||
============================
|
||||
|
||||
Thun is dialect of Joy written in Python.
|
||||
|
||||
Joy is a programming language created by Manfred von Thun that is easy to
|
||||
use and understand and has many other nice properties. This Python
|
||||
package implements an interpreter for a dialect of Joy that attempts to
|
||||
stay very close to the spirit of Joy but does not precisely match the
|
||||
behaviour of the original version(s) written in C. The main difference
|
||||
between Thun and the originals, other than being written in Python, is
|
||||
that it works by the "Continuation-Passing Style".
|
||||
|
||||
|
||||
Quick Start
|
||||
--------------------------------------------------
|
||||
|
||||
Install from PyPI in the usual way::
|
||||
|
||||
$ pip install Thun
|
||||
|
||||
To start the REPL::
|
||||
|
||||
$ python -m joy
|
||||
|
||||
|
||||
Hey there!
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:caption: Contents:
|
||||
|
||||
joy
|
||||
stack
|
||||
parser
|
||||
pretty
|
||||
library
|
||||
lib
|
||||
|
||||
.. automodule:: joy.joy
|
||||
:members:
|
||||
|
||||
|
||||
Indices and tables
|
||||
|
||||
@@ -0,0 +1,9 @@
|
||||
|
||||
Joy Interpreter
|
||||
===============
|
||||
|
||||
|
||||
.. automodule:: joy.joy
|
||||
:members:
|
||||
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -1,9 +1,9 @@
|
||||
|
||||
Functions, Combinators and Definitions
|
||||
Function Reference
|
||||
======================================
|
||||
|
||||
|
||||
. . automodule:: joy.library
|
||||
.. automodule:: joy.pribrary
|
||||
:members:
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user