view docs/README @ 6223:4298ae0b966d stable

evolve: don't update wdir when --dry-run is given (issue6669)

What _cleanup() should've been called, perhaps, is _update(). Because it
updates working copy to either headnode or a successor of startnode. And yes,
it performs an update even when shouldupdate is False. So when --dry-run is
given, we should simply avoid calling _cleanup().

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.