From 34eb23ba24e869646255f0025faaf45f9664b4d6 Mon Sep 17 00:00:00 2001 From: Merlijn Wajer Date: Tue, 19 Jul 2011 13:47:24 +0200 Subject: [PATCH] Documentation: More changes. --- Doc/sphinx/docdoc.rst | 11 +++++++---- Doc/sphinx/gettingstarted.rst | 1 + Doc/sphinx/index.rst | 25 +++++++++++++++++++++---- Doc/sphinx/referencescript.rst | 2 ++ Doc/sphinx/whatis.rst | 2 ++ 5 files changed, 33 insertions(+), 8 deletions(-) diff --git a/Doc/sphinx/docdoc.rst b/Doc/sphinx/docdoc.rst index 454c31e..f86af9d 100644 --- a/Doc/sphinx/docdoc.rst +++ b/Doc/sphinx/docdoc.rst @@ -1,7 +1,9 @@ +.. _docdoc: + Documentation Documentation =========================== -This page is the documentation for the documentation. +This page is the documentation for the documentation. It is very important to know this by heart when you are writing documentation for Simba. @@ -18,12 +20,13 @@ be found at the bottom of the page. Building the documentation -------------------------- + In the future, the online documentation will be refreshed every hour. However, if you want to build the documentation yourself, you should install -``python-sphinx``. +``python-sphinx``. -Move to the ``Simba/doc/sphinx`` directory and run ``make all``. -This will place an HTML version of the documentation in ``_build/html``. +Move to the ``Simba/doc/sphinx`` directory and run ``make all``. +This will place an HTML version of the documentation in ``_build/html``. .. note:: The build instructions are for Linux only. If you want to build the doc on diff --git a/Doc/sphinx/gettingstarted.rst b/Doc/sphinx/gettingstarted.rst index 52f2f7c..e7d9b27 100644 --- a/Doc/sphinx/gettingstarted.rst +++ b/Doc/sphinx/gettingstarted.rst @@ -1,3 +1,4 @@ +.. _gettingstarted: Getting Started with Simba ========================== diff --git a/Doc/sphinx/index.rst b/Doc/sphinx/index.rst index 30d9705..2dd9792 100644 --- a/Doc/sphinx/index.rst +++ b/Doc/sphinx/index.rst @@ -7,11 +7,28 @@ Welcome to the Simba documentation! =================================== .. note:: - The documentation is still WIP (Work In Progress) -Welcome to the Documentation for the Simba project. -This documentation is aimed at providing documentation on just about anything -you'd want to know about Simba. + Welcome to the Documentation for the Simba project. + The documentation is actively being worked on and somewhat incomplete. + +This documentation aims to provide information on just about anything +there is to know about Simba. + +Starting points are :ref:`whatis`, :ref:`gettingstarted` and the :ref:`scriptref` + +Want to help out with the documentation? See :ref:`docdoc`. + + +Simba is a program used to repeat certain (complicated) tasks. Typically these +tasks involve using the mouse and keyboard. Simba is programmable, which means +you can design your own logic and steps that Simba will follow, based upon +certain input or as a reaction to a certain action. + +Simba is created by the SRL community, fully open source and actively +maintained. + +For community forums see http://villavu.com/ + Contents: diff --git a/Doc/sphinx/referencescript.rst b/Doc/sphinx/referencescript.rst index 28e2097..33c4848 100644 --- a/Doc/sphinx/referencescript.rst +++ b/Doc/sphinx/referencescript.rst @@ -1,3 +1,5 @@ +.. _scriptref: + Scripting Reference =================== diff --git a/Doc/sphinx/whatis.rst b/Doc/sphinx/whatis.rst index 4782ec5..e9e8479 100644 --- a/Doc/sphinx/whatis.rst +++ b/Doc/sphinx/whatis.rst @@ -1,3 +1,5 @@ +.. _whatis: + What Is Simba? ==============