view docs/README @ 5705:9f8ff149f258

tests: remove branch cache entries from test-discovery-obshashrange.t

The previous commit added new blackbox entries, and among them many branch
cache-related lines like these. Unfortunately, their order was not stable in
case of writing an empty cache (0 labels and 0 nodes) on py2.

Since branch cache entries aren't vital for this test, we can drop them and
remove the flakiness.

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.