view docs/README @ 3799:037ccbf41c6d

tests: make sure we don't result in commit messages conflict

Upcoming patches will introduce functionality of merging commit messages while
resolving content divergence which can lead to conflicts.

We don't want to test the conflicts scenario here, so let's make sure there are
no conflicts of commit messages in this test.

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.