summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSteve Chaplin <>2011-04-17 20:15:33 +0800
committerSteve Chaplin <>2011-04-17 20:15:33 +0800
commit1a07f16bbe07054d1d043f80b3189014c00470d3 (patch)
tree29f0d6c5624c02e629ff4e935175f1e776637f34
parent131556cb563f153b2f3d192f118c7a5b7d0b79aa (diff)
downloadpy2cairo-1a07f16bbe07054d1d043f80b3189014c00470d3.tar.gz
Update 'waf dist' so that generated docs (not just the docs source) are
included in the pycairo archive file.
-rw-r--r--doc/README15
-rw-r--r--doc/reference/constants.rst7
-rw-r--r--wscript9
3 files changed, 21 insertions, 10 deletions
diff --git a/doc/README b/doc/README
index b584604..f6012e3 100644
--- a/doc/README
+++ b/doc/README
@@ -1,16 +1,17 @@
Pycairo Documentation README
----------------------------
-This directory contains the reStructuredText (reST) sources to the Pycairo
+This directory contains the reStructuredText (reST) sources for the Pycairo
documentation.
-Options for accessing pycairo documentation:
-1. Read the documentation online at
-http://cairographics.org/documentation/pycairo/
+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. 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.
+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.
diff --git a/doc/reference/constants.rst b/doc/reference/constants.rst
index 18454d6..9487059 100644
--- a/doc/reference/constants.rst
+++ b/doc/reference/constants.rst
@@ -247,6 +247,8 @@ cairo.FORMAT
These constants are used to identify the memory format of
:class:`ImageSurface` data.
+New entries may be added in future versions.
+
.. data:: FORMAT_ARGB32
each pixel is a 32-bit quantity, with alpha in the upper 8 bits, then red,
@@ -271,7 +273,10 @@ These constants are used to identify the memory format of
the uppermost bit, on a little-endian machine the first pixel is in the
least-significant bit.
-New entries may be added in future versions.
+.. data:: FORMAT_RGB16_565
+
+ each pixel is a 16-bit quantity with red in the upper 5 bits, then green in
+ the middle 6 bits, and blue in the lower 5 bits.
.. _constants_HINT_METRICS:
diff --git a/wscript b/wscript
index edf3527..7b46e41 100644
--- a/wscript
+++ b/wscript
@@ -68,10 +68,15 @@ def build(ctx):
def dist(ctx):
# exclude these files from the distribution archive
exclude = (
- 'RELEASING',
- 'examples/cairo_snippets/c_to_python.py',
+ 'build_directory/',
'doc/html_docs_create.sh',
'doc/html_docs_upload.sh',
+ 'doc/_static/',
+ 'doc/_templates/',
+ 'doc/_build/doctrees/',
+ 'doc/_build/html/_sources/',
+ 'examples/cairo_snippets/c_to_python.py',
+ 'RELEASING',
'.git/',
'**/.gitignore',