docs/README
author Denis Laxalde <denis@laxalde.org>
Thu, 07 Dec 2017 20:34:18 +0100
branchstable
changeset 3233 bd01eb0108f4
parent 2959 ef361938dfa1
permissions -rw-r--r--
touch: shorten touch's docstring to make it fit into a one line This make it show completely (untruncated) in `hg help -e evolve`. This follows up on fed946edc293 where the docstring got unwrap for that purpose and thus made the line length exceed 80 columns.

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.