docs/README
author Martin von Zweigbergk <martinvonz@google.com>
Mon, 25 Mar 2019 15:45:11 -0700
branchstable
changeset 4446 8232bddf543a
parent 2959 ef361938dfa1
permissions -rw-r--r--
touch: use action "touch", not "<function touch at ...>", in precheck I just got this message: abort: cannot <function touch at 0x7fde174b69b0> public changesets: f177c51ae98f It has been this way since 1b7b9acda2a9 (touch: use precheck to validate revision, 2017-07-23).

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.