view docs/README @ 6794:68f7ba35ea83 stable

topic: bring back oldbranchmap context manager for hg 4.9

This is only needed in Mercurial 4.9 because branchcache class there tries to
use super() in its __init__() and it results in an infinite recursion because
we also implement __init__() with super() in _topiccache and then replace the
original branchmap.branchcache class with our own.

At least there are now compatibility comments to help remove this hack ASAP.

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.