view docs/README @ 6259:fc60328270ac

tests: add branch to checkheads-related log output

Just an additional branch is not going to make log output unreadable. The
branch is added even if topic is unset.

This is for consistency with tests that check single head enforcement, that
also get initialized using push-checkheads-util.sh, but previously used a
separate, almost identical, log template. Now they all use the same template.

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.