docs/README
author Anton Shestakov <av6@dwimlabs.net>
Fri, 08 May 2020 19:22:36 +0800
branchmercurial-5.3
changeset 5359 01bcd39c432c
parent 2959 ef361938dfa1
permissions -rw-r--r--
test-compat: back out changeset 4da1d21231ae

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.