docs/README
author Anton Shestakov <av6@dwimlabs.net>
Fri, 10 Apr 2020 10:13:48 +0800
branchstable
changeset 5292 8c44f02e7200
parent 2959 ef361938dfa1
permissions -rw-r--r--
manifest: now that there's only one legacy.py, exclude it After the last patch, this file is only included because of package_dir in setup.py (i.e. just once), so we can ignore it with just one clause. But package_dir starts with "./", so we need to add it to the pattern.

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.