view docs/README @ 6926:e4777a1d0655 stable

Added tag 11.1.5 for changeset 6219898ee0ad
author Anton Shestakov <av6@dwimlabs.net>
date Sat, 26 Oct 2024 10:26:00 +0400
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.