mirror of
https://github.com/moparisthebest/Simba
synced 2024-11-25 10:42:20 -05:00
Autodoc for PyMML + WhySimba.
This commit is contained in:
parent
97a94d5679
commit
136b5f5c20
@ -18,11 +18,13 @@ import sys, os
|
||||
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
||||
#sys.path.append(os.path.abspath('.'))
|
||||
|
||||
sys.path.append(os.path.abspath('../../Projects/MMLLib/pymml'))
|
||||
|
||||
# -- General configuration -----------------------------------------------------
|
||||
|
||||
# Add any Sphinx extension module names here, as strings. They can be extensions
|
||||
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
||||
extensions = []
|
||||
extensions = ['sphinx.ext.autodoc']
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
templates_path = ['_templates']
|
||||
|
@ -22,6 +22,7 @@ Contents:
|
||||
reference.rst
|
||||
scriptreference.rst
|
||||
docdoc.rst
|
||||
pymml.rst
|
||||
|
||||
|
||||
Indices and tables
|
||||
|
11
Doc/sphinx/pymml.rst
Normal file
11
Doc/sphinx/pymml.rst
Normal file
@ -0,0 +1,11 @@
|
||||
.. _py-mml:
|
||||
|
||||
Python MML
|
||||
==========
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
pymml/mouse.rst
|
||||
pymml/color.rst
|
||||
|
8
Doc/sphinx/pymml/color.rst
Normal file
8
Doc/sphinx/pymml/color.rst
Normal file
@ -0,0 +1,8 @@
|
||||
PyMML Color
|
||||
===========
|
||||
|
||||
This is the PyMML color class.
|
||||
|
||||
.. automodule:: mmlcolor
|
||||
:members:
|
||||
|
8
Doc/sphinx/pymml/mouse.rst
Normal file
8
Doc/sphinx/pymml/mouse.rst
Normal file
@ -0,0 +1,8 @@
|
||||
PyMML Mouse
|
||||
===========
|
||||
|
||||
This is the PyMML mouse class.
|
||||
|
||||
.. automodule:: mmlmouse
|
||||
:members:
|
||||
|
@ -2,3 +2,35 @@ Why Simba?
|
||||
==========
|
||||
|
||||
GEWOON MAN
|
||||
|
||||
*
|
||||
|
||||
Programmable
|
||||
In fact, the only way to use it, is to write a program that Simba will execute.
|
||||
*
|
||||
|
||||
Extensible
|
||||
Simba supports both plugins in machine code as well as extensions written in the Simba programming language. (Pascal)
|
||||
*
|
||||
|
||||
Free (As in Free Beer and as in Freedom)
|
||||
|
||||
Simba is 100% free to use. In fact, we welcome you to share it with the rest of the world.
|
||||
|
||||
The source code to the program is also freely available, under the GPL license.
|
||||
*
|
||||
|
||||
Reliable
|
||||
Simba is actively maintained by a team of knowledgable programmers. We as a team do our best to make Simba into a quality product. However: this does not guarantee a bug free program. (Bug free programs don't exist)
|
||||
*
|
||||
|
||||
Cross Platform
|
||||
|
||||
Simba has been written with freedom in mind and believes Simba should not be limited to one platform, as that limits its users to one platform as well. Currently the supported platforms are Windows and Linux.
|
||||
|
||||
Even though we try hard to make Simba bug-free on all platforms, some issues remain. The biggest issue is the component that executes your program. It is an external component and does not play too well on Linux. Hopefully we will be able to fix this soon.
|
||||
*
|
||||
|
||||
Quite fast
|
||||
The Simba developers have designed and written Simba with speed in mind. However, focussing too much on speed is in reality not a good case. It often leads to instability and more bugs in the program. For Simba, we have sacraficed some speed to make a more featureful and stable program.
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user