mirror of
https://github.com/moparisthebest/Simba
synced 2024-11-21 16:55:01 -05:00
Documentation: More changes.
This commit is contained in:
parent
cac637ea02
commit
34eb23ba24
@ -1,7 +1,9 @@
|
|||||||
|
.. _docdoc:
|
||||||
|
|
||||||
Documentation Documentation
|
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
|
It is very important to know this by heart when you are writing documentation
|
||||||
for Simba.
|
for Simba.
|
||||||
@ -18,12 +20,13 @@ be found at the bottom of the page.
|
|||||||
|
|
||||||
Building the documentation
|
Building the documentation
|
||||||
--------------------------
|
--------------------------
|
||||||
|
|
||||||
In the future, the online documentation will be refreshed every hour. However,
|
In the future, the online documentation will be refreshed every hour. However,
|
||||||
if you want to build the documentation yourself, you should install
|
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``.
|
Move to the ``Simba/doc/sphinx`` directory and run ``make all``.
|
||||||
This will place an HTML version of the documentation in ``_build/html``.
|
This will place an HTML version of the documentation in ``_build/html``.
|
||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
The build instructions are for Linux only. If you want to build the doc on
|
The build instructions are for Linux only. If you want to build the doc on
|
||||||
|
@ -1,3 +1,4 @@
|
|||||||
|
.. _gettingstarted:
|
||||||
|
|
||||||
Getting Started with Simba
|
Getting Started with Simba
|
||||||
==========================
|
==========================
|
||||||
|
@ -7,11 +7,28 @@ Welcome to the Simba documentation!
|
|||||||
===================================
|
===================================
|
||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
The documentation is still WIP (Work In Progress)
|
|
||||||
|
|
||||||
Welcome to the Documentation for the Simba project.
|
Welcome to the Documentation for the Simba project.
|
||||||
This documentation is aimed at providing documentation on just about anything
|
The documentation is actively being worked on and somewhat incomplete.
|
||||||
you'd want to know about Simba.
|
|
||||||
|
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:
|
Contents:
|
||||||
|
|
||||||
|
@ -1,3 +1,5 @@
|
|||||||
|
.. _scriptref:
|
||||||
|
|
||||||
Scripting Reference
|
Scripting Reference
|
||||||
===================
|
===================
|
||||||
|
|
||||||
|
@ -1,3 +1,5 @@
|
|||||||
|
.. _whatis:
|
||||||
|
|
||||||
What Is Simba?
|
What Is Simba?
|
||||||
==============
|
==============
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user