view docs/README @ 6210:6ae0077e416e stable

state: allow to unvendor cbor

This makes evolve fallback to an externally provided version of
the `cbor` library, which in turns allows distributions such as Debian
not to include the vendored `cbor.py` and rely on their own provided
version instead.

The price to pay is the immediate attempt to import the vendored `cbor`,
to circumvent that hgdemandimport never raises `ImportError` immediately.

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.