view docs/README @ 4939:7aba58dc4b73

obslog: use plural name "effects" for list of all effects

Same reasoning as the previous patch, but here the singular was used
for the list instead.

This patch also renames the variable that represents the list of
effects to plural "effects" to reduce confusion.

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.