view docs/README @ 3700:2577fdc3a458

compat: drop compatibility layer for duplicatecopies We no longer support version before Mercurial 4.3.
author Pierre-Yves David <pierre-yves.david@octobus.net>
date Thu, 19 Apr 2018 16:25:17 +0200
parents ef361938dfa1
children
line wrap: on
line source

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.