view docs/README @ 6841:83a8122cfd8c

ci: run checks-py3 using v2.0 images

The changes in test-check-sdist.t are related to the "egg-info" directory
inside the tarball. Apparently the newer versions of whatever `setup.py sdist`
is using now adds this directory with various meta information about the
package, so now we have 5 more files in the tarball. The exact files are:

  hg_evolve.egg-info/
  hg_evolve.egg-info/PKG-INFO
  hg_evolve.egg-info/SOURCES.txt
  hg_evolve.egg-info/dependency_links.txt
  hg_evolve.egg-info/top_level.txt

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.