view docs/README @ 4965:191ed83dbc07

pytype: ignore abc.ABCMeta metaclasses that don't work on py3

See 70d42e2ad9b4 in hg:

    We can remove this when we're Python 3-only, but for now it's just too
    awkward to deal with and it's harmless.

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.