docs/README
author Sushil khanchi <sushilkhanchi97@gmail.com>
Wed, 10 Apr 2019 15:26:41 +0200
branchstable
changeset 4482 ee7e4e05ce44
parent 2959 ef361938dfa1
permissions -rw-r--r--
evolve: add test which demonstrate issue6113 This patch introducing a new test file which contains the test for issue6113 which is `test-evolve-content-divergent-distributed.t`. This test file is supposed to contain tests for distributed workflows. Next patch will fix the bug.

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.