docs/README
author Dan Villiom Podlaski Christiansen <dan@magenta.dk>
Tue, 21 Aug 2018 12:14:04 +0200
branchstable
changeset 3989 b60113460856
parent 2959 ef361938dfa1
permissions -rw-r--r--
prune: improve help first line The previous help string for prune didn't mention successors in the first line. Note: Pierre-Yves David changed the original "hidden" to "obsolete" as it is better concept to put forward. (a bit more specific and with more consequence than just "hidden"). We need a good `hg help obsolete/obsolescence` result. We'll try to get this in the next version.

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.