-
Notifications
You must be signed in to change notification settings - Fork 2
Pergola meta manual
jose edited this page Aug 10, 2015
·
1 revision
Pergola documentation is written in the RestructuredText format by using the Sphinx tool.
You need GNU make and Python installed in your computer
-
Install Sphinx by using the command:
easy_install -U Sphinx
-
Clone the Pergola repository from Github (if you don't have it already):
git clone [email protected]:cbcrg/pergola.git
-
Move to the doc dir:
cd pergola/doc
-
Edit the
.rst
files with your favourite text editor. At this link there's an useful rst format primer:
http://sphinx-doc.org/rest.html
- File
page-example.rst
contains a generic page template that you can use to start a new documentation page