docs/README
author Pierre-Yves David <pierre-yves.david@octobus.net>
Tue, 10 Oct 2017 15:47:11 +0200
branchstable
changeset 3044 b185beb94df5
parent 2959 ef361938dfa1
permissions -rw-r--r--
topic: reorder revset for faster evaluation When running the revset on unfiltered repository, the mutable set can get huge. So removing the obsolete changeset first provide a large speedup. This resolve the performance regression we were seeing since the 6.7.0 release.

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.