docs/README
author Anton Shestakov <av6@dwimlabs.net>
Thu, 07 Mar 2019 19:13:45 +0800
changeset 4432 5da1d162ad50
parent 2959 ef361938dfa1
permissions -rw-r--r--
stack: rename unstable -> orphan That's the only instability stack can currently show, but it's about to show more and showing "unstable" for one type of instability just isn't good.

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.