view docs/README @ 4119:c4b891fe44c3 stable

obsdiscovery: adopt to calling convention change

Upstream commits 71d83b315778 and abce899c985f changed the calling
convention of setdiscovery._takefullsample().

We inspect the signature of the function before calling it so
we can pass the proper arguments.

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.