view docs/README @ 4310:980565468003

tests: filter out uninteresting log events

Core has new ui.log() calls added (for tracking extension loading and
performance, for example), but in test-discovery-obshashrange.t it produces a
bunch of lines that are unrelated to the test. So we filter them out to not
touch test output. This is inspired by 1de3364320af in core.

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.