docs/README
author Sushil khanchi <sushilkhanchi97@gmail.com>
Sun, 21 Apr 2019 12:06:31 +0530
changeset 4585 d871c8a92dee
parent 2959 ef361938dfa1
permissions -rw-r--r--
test: remove duplicated test We have the test in test-evolve-orphan-split.t which is covering the same case this test does. Also this test states that evolve shows some error in split case, but now this is not the case we update to the top of splitted csets.

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.