annotate docs/README @ 6788:0674b56d3526 stable

topic: drop oldbranchmap context manager, _topiccache is now a mixin

I think this hack was needed back then in d49f75eab6a3 because _topiccache was
a subclass of branchmap.branchcache directly, but now it's a mixin. In any
case, I didn't see any failures in the tests, so it should be fine.

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.