docs/README
author Pierre-Yves David <pierre-yves.david@octobus.net>
Thu, 02 Aug 2018 02:41:33 +0200
branchstable
changeset 3925 3c2a464ae6fc
parent 2959 ef361938dfa1
permissions -rw-r--r--
format: fix indentation level Previous change got pushed without the fix by mistake.

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.