docs/README
author Pulkit Goyal <pulkit@yandex-team.ru>
Thu, 01 Nov 2018 21:33:15 +0300
branchstable
changeset 4222 b757f06193d0
parent 2959 ef361938dfa1
permissions -rw-r--r--
utility: don't translate commit messages in revselection prompt (issue6016) Commit messages should not be translated and should be shown the same. I am not sure if I can add a test for this by creating a commit with non-ascii character in commit message.

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.