view docs/README @ 4846:38ce7fe4d3f2

cmdstate: switch to new-style classes

This isn't a huge issue and isn't necessary on Python3, but we're still Python2
compatible and we should be consistent (and strongly prefer new-style classes);
this is the only class that is not deriving from object that I could find.

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.