docs/README
author Pierre-Yves David <pierre-yves.david@octobus.net>
Tue, 21 Aug 2018 04:05:12 +0200
changeset 3982 7b1af75e12a9
parent 2959 ef361938dfa1
permissions -rw-r--r--
compat: import the module dagutil module in evolve Discovery code is core have been rewritten to no longer depends on dagutil and the module have been removed. This break evolve's obsmarker discovery (older version of the discovery use the same concept).. A quick work around is to import the dagutil module in evolve and use that for now.

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.