diff --git a/docs/VUI-docs/source/_static/packages_Vui.png b/docs/VUI-docs/source/_static/packages_Vui.png index 3d2e0f7..a1e8936 100644 Binary files a/docs/VUI-docs/source/_static/packages_Vui.png and b/docs/VUI-docs/source/_static/packages_Vui.png differ diff --git a/docs/VUI-docs/source/core.rst b/docs/VUI-docs/source/core.rst new file mode 100644 index 0000000..06bc602 --- /dev/null +++ b/docs/VUI-docs/source/core.rst @@ -0,0 +1,3 @@ + +.. automodule:: joy.vui.core + :members: diff --git a/docs/VUI-docs/source/display.rst b/docs/VUI-docs/source/display.rst new file mode 100644 index 0000000..6083403 --- /dev/null +++ b/docs/VUI-docs/source/display.rst @@ -0,0 +1,3 @@ + +.. automodule:: joy.vui.display + :members: diff --git a/docs/VUI-docs/source/index.rst b/docs/VUI-docs/source/index.rst index 515373d..74d4b4b 100644 --- a/docs/VUI-docs/source/index.rst +++ b/docs/VUI-docs/source/index.rst @@ -6,31 +6,42 @@ 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 +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:: :maxdepth: 2 :caption: Contents: - - -.. automodule:: joy.vui.core - :members: - - -.. automodule:: joy.vui.display - :members: - - -.. automodule:: joy.vui.viewer - :members: - - -.. automodule:: joy.vui.text_viewer - :members: - - -.. automodule:: joy.vui.stack_viewer - :members: + + core + display + viewer + text_viewer + stack_viewer + persist_task Indices and tables diff --git a/docs/VUI-docs/source/persist_task.rst b/docs/VUI-docs/source/persist_task.rst new file mode 100644 index 0000000..ef05e2c --- /dev/null +++ b/docs/VUI-docs/source/persist_task.rst @@ -0,0 +1,3 @@ + +.. automodule:: joy.vui.persist_task + :members: diff --git a/docs/VUI-docs/source/stack_viewer.rst b/docs/VUI-docs/source/stack_viewer.rst new file mode 100644 index 0000000..60f3458 --- /dev/null +++ b/docs/VUI-docs/source/stack_viewer.rst @@ -0,0 +1,3 @@ + +.. automodule:: joy.vui.stack_viewer + :members: diff --git a/docs/VUI-docs/source/text_viewer.rst b/docs/VUI-docs/source/text_viewer.rst new file mode 100644 index 0000000..7918dbc --- /dev/null +++ b/docs/VUI-docs/source/text_viewer.rst @@ -0,0 +1,3 @@ + +.. automodule:: joy.vui.text_viewer + :members: diff --git a/docs/VUI-docs/source/viewer.rst b/docs/VUI-docs/source/viewer.rst new file mode 100644 index 0000000..6864c84 --- /dev/null +++ b/docs/VUI-docs/source/viewer.rst @@ -0,0 +1,3 @@ + +.. automodule:: joy.vui.viewer + :members: diff --git a/joy/vui/persist_task.py b/joy/vui/persist_task.py index 45ed8c4..b4dc1ad 100644 --- a/joy/vui/persist_task.py +++ b/joy/vui/persist_task.py @@ -17,6 +17,12 @@ # You should have received a copy of the GNU General Public License # along with Thun. If not see . # +''' + +Persist Task +=========================== + +''' import os, pickle, traceback from collections import Counter from dulwich.errors import NotGitRepository