docs/README
author Pierre-Yves David <pierre-yves.david@octobus.net>
Thu, 30 Aug 2018 19:40:18 +0200
changeset 4046 669b32100eca
parent 2959 ef361938dfa1
permissions -rw-r--r--
readme: document the purpose of the evolve extension Another place for the explanation to live.

Doc is generated with sphinx.

You can generate the doc with:

```
make
```

# Tutorials

For updating the tutorials, you need to have the docgraph extension installed
(https://pypi.python.org/pypi/hg-docgraph).

Then run the test-topic-tutorial.t and test-tutorial.t to update the output if
needed.

You'll need the dot binary (likely installed by the graphviz package in your
package manager) in order to have graphviz graphs rendered in the html output.

Simply run make in the docs directory should takes care of the conversion of
the tutorial .t files into .rst files. Then sphinx should do the rest of the
jobs by rendering graphviz graphs.