A bit more on the docs.

diff --git a/docs/VUI-docs/source/_static/packages_Vui.png b/docs/VUI-docs/source/_static/packages_Vui.png
index 3d2e0f7..a1e8936 100644 (file)
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 (file)
index 0000000..06bc602
--- /dev/null
+++ b/docs/VUI-docs/source/core.rst
@@ -0,0 +1,3 @@
+\r
+.. automodule:: joy.vui.core\r
+   :members:\r

diff --git a/docs/VUI-docs/source/display.rst b/docs/VUI-docs/source/display.rst
new file mode 100644 (file)
index 0000000..6083403
--- /dev/null
+++ b/docs/VUI-docs/source/display.rst
@@ -0,0 +1,3 @@
+\r
+.. automodule:: joy.vui.display\r
+   :members:\r

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

diff --git a/docs/VUI-docs/source/persist_task.rst b/docs/VUI-docs/source/persist_task.rst
new file mode 100644 (file)
index 0000000..ef05e2c
--- /dev/null
+++ b/docs/VUI-docs/source/persist_task.rst
@@ -0,0 +1,3 @@
+\r
+.. automodule:: joy.vui.persist_task\r
+   :members:\r

diff --git a/docs/VUI-docs/source/stack_viewer.rst b/docs/VUI-docs/source/stack_viewer.rst
new file mode 100644 (file)
index 0000000..60f3458
--- /dev/null
+++ b/docs/VUI-docs/source/stack_viewer.rst
@@ -0,0 +1,3 @@
+\r
+.. automodule:: joy.vui.stack_viewer\r
+   :members:\r

diff --git a/docs/VUI-docs/source/text_viewer.rst b/docs/VUI-docs/source/text_viewer.rst
new file mode 100644 (file)
index 0000000..7918dbc
--- /dev/null
+++ b/docs/VUI-docs/source/text_viewer.rst
@@ -0,0 +1,3 @@
+\r
+.. automodule:: joy.vui.text_viewer\r
+   :members:\r

diff --git a/docs/VUI-docs/source/viewer.rst b/docs/VUI-docs/source/viewer.rst
new file mode 100644 (file)
index 0000000..6864c84
--- /dev/null
+++ b/docs/VUI-docs/source/viewer.rst
@@ -0,0 +1,3 @@
+\r
+.. automodule:: joy.vui.viewer\r
+   :members:\r

diff --git a/joy/vui/persist_task.py b/joy/vui/persist_task.py
index 45ed8c4..b4dc1ad 100644 (file)
--- 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\r
 #    along with Thun.  If not see <http://www.gnu.org/licenses/>.\r
 #\r
+'''\r
+\r
+Persist Task\r
+===========================\r
+\r
+'''\r
 import os, pickle, traceback\r
 from collections import Counter\r
 from dulwich.errors import NotGitRepository\r