summaryrefslogtreecommitdiff
path: root/doc/README
blob: f6012e38df0089d896ea5a6ae5c79b28e10b3154 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
Pycairo Documentation README
----------------------------

This directory contains the reStructuredText (reST) sources for the Pycairo
documentation.

Accessing pycairo documentation
-------------------------------
There are a number of options:
1. Read the documentation supplied in the pycairo archive file
  pycairo-X.X.X/doc/_build/html/index.html

2. Read the documentation online at
http://cairographics.org/documentation/pycairo/

3. Build the documentation yourself - the hardest option.
Install Sphinx 1.0.7 or later.

Build the docs using sphinx-build
$ sphinx-build -b html sourcedir builddir

or, build the docs using make
$ make clean
$ make html