annotate docs/README @ 5507:95478db35f88 stable

topic: fix the `topic(...)` revset to not select commits without a topic

The problem seems to be that the now removed __contains__ check would select any
revision indicated by a non-string argument.  This led to `topic(head())`
returning a bunch of non-topic heads, though not as many as simply `head()`.

I'm likely misunderstanding something, because there appears to be a similar
__contains__ check for `branch()` in core.  But maybe that's just harder to see
the issue, because branch names doesn't disappear like topics.

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.