view docs/README @ 6029:f69a13a4fe85

evolve: drop 4.6 compat in fixedcopytracing(), update the docstring

Looks like the fix for this function that originally targeted 4.6 got into core
after much more time than planned: the fixed version of this function was only
accepted in 5.0 (7694b685bb10).

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.