docs/README
author Martijn Pieters <mj@octobus.net>
Wed, 21 Nov 2018 12:00:46 +0000
branchstable
changeset 4459 d46360b8c0dc
parent 2959 ef361938dfa1
permissions -rw-r--r--
topic: make topics compatible with branchmap refactor See https://phab.mercurial-scm.org/D5290

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.