docs/README
author Pierre-Yves David <pierre-yves.david@octobus.net>
Sat, 09 Dec 2017 05:05:39 +0100
changeset 3234 a18ca224e812
parent 2959 ef361938dfa1
permissions -rw-r--r--
test: update output to ad5f2b923b0d A new bundle2 capabilities have been added (related to bookmark). So we have to update the test output. CORE-TEST-OUTPUT-UPDATE: ad5f2b923b0d

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.