view docs/README @ 6888:1e836ad40272

obslog: use exception to convey the failure to find a diff pair

I am not a fan of using exceptions for flow control, but it makes more sense
here.

The next patch will actually extend the functionality of patchavailable() to
potentially return things other than just `cand`, and there the use of this
exception will make even more sense.

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.