docs/README
author Rodrigo Damazio Bovendorp <rdamazio@google.com>
Fri, 27 Dec 2019 20:38:10 -0800
changeset 5251 353e546ab324
parent 2959 ef361938dfa1
permissions -rw-r--r--
obslog: add flags to control the output of precursors and successors With just this change, precursors are only shown in structured output.

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.