Skip to content

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.

Prerequisites

You need GNU make and Python installed in your computer

Procedure

  1. Install Sphinx by using the command:

    easy_install -U Sphinx

  2. Clone the Pergola repository from Github (if you don't have it already):

    git clone [email protected]:cbcrg/pergola.git

  3. Move to the doc dir:

    cd pergola/doc

  4. 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

  1. File page-example.rst contains a generic page template that you can use to start a new documentation page
Clone this wiki locally