annotate docs/README @ 6549:e45bfd1e0588

topic: don't write namespace into commit extras if there's no topic

Topic namespace is considered a part of topic, but topic is more important than
just namespace alone, so it doesn't make a lot of sense to have topic namespace
on a commit unless it also has topic.

We could simple ignore topic namespace in such cases, but it makes sense to not
record it at all.

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.