annotate docs/README @ 3253:8dcb9e929a57

stablerange: fallback to a more naive approach to find subrange

As suspected, using "bheads" was bit good enough in some case and we have to
fall back to the approach used in "basic".

On the evolve repo (about 3K changeset) this approach is about 60% slower than
the previous (wrong) code.

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.