docs/README
author Pierre-Yves David <pierre-yves.david@octobus.net>
Fri, 20 Oct 2017 14:56:03 +0200
changeset 3085 3eca2cbdc498
parent 2959 ef361938dfa1
permissions -rw-r--r--
stack: order the adjective of changeset The new order give more interesting result: * base current * base unstable * current unstable It seems more harmonious this way. Base seems the most core and immutable adjective describing the element. Then current is a volatile but important one. Finally, unstable is less information than current, so it goes last.

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.