This documentation uses Python-sphinx. It uses reStructuredText syntax.
The documentation is written in english.
Limit all lines to a maximum of 79 characters.
Use the following symbols to create headings: # * = -
As an example:
##################
H1: document title
##################
*********
Sample H2
*********
Sample H3
=========
Sample H4
---------
And sample text.
If you need more than H4, then consider creating a new document.
Combine a “highlight” directive and a “::” to specify the programming language. As an example:
.. highlight:: python
::
import this
On pages which are quite long, use links and references footnotes with the “target-notes” directive. As an example:
#############
Some document
#############
Some text which includes links to `Example website`_ and many other links.
`Example website`_ can be referenced multiple times.
(... document content...)
And at the end of the document...
**********
References
**********
.. target-notes::
.. _`Example website`: http://www.example.com/
This :doc:documentation page uses this syntax.
Python-sphinx installation is covered in :doc:/dev/install.
In other cases, please refer to Python-sphinx documentation.
Go to lettuce folder and use the provided Makefile:
make documentation
HTML documentation is exported to docs/_build/html/.
This documentation uses the Sphinx's doctest extension.
Here is a RST code sample to write doctests. You can find some doctests in :doc:/reference/terrain.
.. highlight:: python
.. doctest::
>>> print "Hello world!"
Hello world!
See Sphinx's doctest extension and Python's doctest documentations for details.
Go to lettuce folder and use the provided Makefile:
make doctests