annotate docs/README @ 3779:084038b98cd7 stable

next: bail out early in `hg next --evolve` if dirty wdir

This patch adds logic to bail out early when --evolve is passed with next
command and the working directory is dirty.

This will help us in preventing the message saying `do you want --merge` which
is useless and misleading when `--evolve` is passed.

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.