view docs/README @ 4281:ac4bb904f5d8

exthelper: clarify copyright and licence for the module The exthelper is quite useful and Matt Harbison is looking into having it upstreamed. We clarify the legal situation first.
author Pierre-Yves David <pierre-yves.david@octobus.net>
date Sun, 02 Dec 2018 16:45:08 +0100
parents ef361938dfa1
children
line wrap: on
line source

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.