view docs/README @ 5695:8c7de8f8bb42

evolve: respect command-templates.oneline-summary if configured

Mercurial has a new `command-templates.oneline-summary` config that is
respected by `hg rebase`, `hg phabsend`, and the bundled version of
`hg split`. This patch makes `hg evolve` also respect it. Unlike the
upstream commands, I let `hg evolve` use the existing template by
default. The reason I didn't change the default is that we have a
different template when topics are enabled and it's unclear how that
should work with the default from upstream. So at least for now, the
user will have to explicitly set the new config if they want it to
apply to `hg evolve`.

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.