sforman
/
Thun
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

A bit more on the docs.

This commit is contained in:
Simon Forman 2019-05-07 10:23:43 -07:00
parent 028ecc0287
commit 13515b071b
9 changed files with 55 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
docs/VUI-docs/source/_static/packages_Vui.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 40 KiB

After

Width:  |  Height:  |  Size: 30 KiB

3
docs/VUI-docs/source/core.rst Normal file
View File

@ -0,0 +1,3 @@
.. automodule:: joy.vui.core
:members:

3
docs/VUI-docs/source/display.rst Normal file
View File

@ -0,0 +1,3 @@
.. automodule:: joy.vui.display
:members:

51
docs/VUI-docs/source/index.rst
View File

@ -6,31 +6,42 @@
Welcome to Joy VUI's documentation! Welcome to Joy VUI's documentation!
=================================== ===================================
A simple Graphical User Interface for the Joy programming language,
written using Pygame to bypass X11 et. al., modeled on the Oberon OS, and
intended to be just functional enough to support bootstrapping further Joy
development.
Screenshot
-----------------------------
.. image:: _static/Joy-VUI-screenshot.PNG .. image:: _static/Joy-VUI-screenshot.PNG
If you have PyGame and Dulwich installed you should be able to start the
VUI with the following command:
::
python -m joy.vui
This will create a `~/.thun` directory in your home dir to store your
data.
Modules
-----------------------------
.. image:: _static/packages_Vui.png
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
:caption: Contents: :caption: Contents:
core
.. automodule:: joy.vui.core display
:members: viewer
text_viewer
stack_viewer
.. automodule:: joy.vui.display persist_task
:members:
.. automodule:: joy.vui.viewer
:members:
.. automodule:: joy.vui.text_viewer
:members:
.. automodule:: joy.vui.stack_viewer
:members:
Indices and tables Indices and tables

3
docs/VUI-docs/source/persist_task.rst Normal file
View File

@ -0,0 +1,3 @@
.. automodule:: joy.vui.persist_task
:members:

3
docs/VUI-docs/source/stack_viewer.rst Normal file
View File

@ -0,0 +1,3 @@
.. automodule:: joy.vui.stack_viewer
:members:

3
docs/VUI-docs/source/text_viewer.rst Normal file
View File

@ -0,0 +1,3 @@
.. automodule:: joy.vui.text_viewer
:members:

3
docs/VUI-docs/source/viewer.rst Normal file
View File

@ -0,0 +1,3 @@
.. automodule:: joy.vui.viewer
:members:

6
joy/vui/persist_task.py
View File

@ -17,6 +17,12 @@
# You should have received a copy of the GNU General Public License # You should have received a copy of the GNU General Public License
# along with Thun. If not see <http://www.gnu.org/licenses/>. # along with Thun. If not see <http://www.gnu.org/licenses/>.
# #
'''
Persist Task
===========================
'''
import os, pickle, traceback import os, pickle, traceback
from collections import Counter from collections import Counter
from dulwich.errors import NotGitRepository from dulwich.errors import NotGitRepository