view docs/README @ 6135:ce7da767c7f6 stable

evolve: make _computeobsoleteset() return a frozenset

Let's make sure that obsolete.getrevs(repo, b'obsolete') returns a frozenset to
be compatible with Mercurial 6.1. This shouldn't produce any issues on older
versions, because I doubt anything tries to modify a set of obsolete revisions
by calling .add() or .remove() directly on it.

See 27fe84a8dd60 and c7e675848027 in core.

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.