docs/README
author Pulkit Goyal <pulkit@yandex-team.ru>
Tue, 02 Oct 2018 20:38:37 +0300
changeset 4150 01ad46551d7c
parent 2959 ef361938dfa1
permissions -rw-r--r--
tests: update the test-topic.t with changes in core mercurial Yuya stabilized the -T option and now it's in help by default. CORE-TEST-OUTPUT-UPDATE: 0d703063d0c8

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.