docs/README
author Martin von Zweigbergk <martinvonz@google.com>
Fri, 08 Nov 2019 07:19:18 -0800
changeset 4950 60d2065b720b
parent 2959 ef361938dfa1
permissions -rw-r--r--
obslog: remove now-unused code for plain styling We now always use a non-plain formatter for the non-local-filtering code paths, so we can remove the code for plain styling. I couldn't figure out how to replace the fm.formatlist() by something less about formatting, so I've only removed the irrelevant arguments from those calls.

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.