annotate docs/README @ 6887:45cbf0af48e7 stable

tests: update old changeset hashes in test-tutorial.t

They actually should've been updated in 32ed5b6fadd3, but better late than
never.

Unfortunately, these messages are not tied directly to any command output, so
the issue with using nonexistent hashes was not immediately obvious after
running 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.