docs/README
author Sushil khanchi <sushilkhanchi97@gmail.com>
Fri, 22 Mar 2019 00:16:44 +0530
changeset 4441 f606eab8dff8
parent 2959 ef361938dfa1
permissions -rw-r--r--
evolve: add a test reflecting wrong behaviour of content-div resolution This patch shows that currently the case when stack of divergent csets have different parents is not handled correctly. For a stack of csets which has different parent, right behaviour is to relocate every node before performing merge but present implementation only relocate first cset in the stack and skip relocation for the rest of csets, this is not what we expect it to do. Next patch will be about fixing this issue.

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.