docs/README
author Pulkit Goyal <pulkit@yandex-team.ru>
Sat, 18 Aug 2018 21:01:14 +0530
branchstable
changeset 3977 a0a4f4de9ea3
parent 2959 ef361938dfa1
permissions -rw-r--r--
evolvecmd: import mercurial.node module as nodemod We use node as a variable name at few places and the conflicts with variable name are not good. Moreover this practice is followed in core mercurial also.

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.