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

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

Options for accessing pycairo documentation:
1. Read the documentation online at
http://cairographics.org/documentation/pycairo/

2. Download the latest 'pycairo-x.x.x-docs-html.tar.gz' prebuilt documents
from http://www.cairographics.org/releases/. Uncompress the docs and point
your browser at the index.html file.

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