docs/README
author Pierre-Yves David <pierre-yves.david@octobus.net>
Tue, 07 Nov 2017 14:07:19 +0100
changeset 3180 85ab7d2d9fd6
parent 2959 ef361938dfa1
permissions -rw-r--r--
test: update test output for effect flag by default Now that effect flag is in core and turned on by default, this affect topic test that did not had the evolve extension turned on all the time. CORE-TEST-OUTPUT-UPDATE: a7e49a5b3e6f

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.