view docs/README @ 6216:ce46b853d10e

prune: add a test to demonstrate a bug

Test shows that pruning without any successor warns about creating
divergence which is not possible and is a false warning.

For the knowledge, this pattern of pruning (without any successor) an
already pruned cset is sometime used to keep successors locally but
vanish them at server side.

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.