docs/README
author Aurélien Campéas
Fri, 22 Sep 2017 16:41:37 +0200
changeset 2986 4746b92cc1f8
parent 2959 ef361938dfa1
permissions -rw-r--r--
topics/ui: signal when an operation entails voiding a topic Typical situations may include: * publish * push (to publishing server) * pull * fold

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.