annotate docs/README @ 6929:972d98ce3552 stable

evolve: unrelated parts of splits are no longer considered content-divergent

Let's backport e68fe567a780 from core that improves content-divergence
computation. This way we can both provide a better experience to evolve
extension users on older Mercurial versions, and don't have to fix evolve tests
for hg 6.1 that we use for one of our CI jobs.

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.