docs/README
author Pulkit Goyal <7895pulkit@gmail.com>
Fri, 06 Apr 2018 14:56:27 +0530
changeset 3654 23e515ca0143
parent 2959 ef361938dfa1
permissions -rw-r--r--
CHANGELOG: add an entry about `hg evolve --abort` Previous patches added a new flag `--abort` for `hg evolve` which aborts an interrupted evolve. Currently this only works for orphan resolution cases which is very common and most people use `evolve` for that. So let's add an entry about that.

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.