view docs/README @ 5954:fb90474ec53f

evolve: wrap the more modern wireprotov1server._capabilities()

This function is recommended for wrapping instead of capabilities(). It also
needs less code from extensions, as this patch demonstrates.

The function exists since 982f13bef503, which is 2014, so we can rely on this
function to be present in any modern Mercurial.

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.