summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSteve Chaplin <stevech1097@yahoo.com.au>2010-05-21 15:39:21 +0800
committerSteve Chaplin <stevech1097@yahoo.com.au>2010-05-21 15:39:21 +0800
commitc2b7a7d2f71b92dff191e3c7468c48849adec668 (patch)
tree4d1d6a0505953e77f485e9004681b87c21b860e8
parent3228ab7d3ae6495691676b0bdfe6fe39f7bd5c32 (diff)
downloadpy2cairo-c2b7a7d2f71b92dff191e3c7468c48849adec668.tar.gz
Documentation fixes.
-rw-r--r--RELEASING10
-rw-r--r--doc/pycairo_c_api.rst2
-rw-r--r--doc/reference/surfaces.rst8
-rw-r--r--wscript2
4 files changed, 12 insertions, 10 deletions
diff --git a/RELEASING b/RELEASING
index 87bb14d..61e1733 100644
--- a/RELEASING
+++ b/RELEASING
@@ -74,15 +74,15 @@ $ vi conf.py # update the version and release numbers
$ make clean
$ make html
$ cd .build/
-$ mv html pycairo-x.x.x-docs-html
-$ tar cjf /tmp/pycairo-x.x.x-docs-html.tar.bz2 pycairo-x.x.x-docs-html
-$ zip -r /tmp/pycairo-x.x.x-docs-html.zip pycairo-x.x.x-docs-html
-$ chmod a+r /tmp/pycairo*
+$ mv html py2cairo-x.x.x-docs-html
+$ tar cjf /tmp/py2cairo-x.x.x-docs-html.tar.bz2 py2cairo-x.x.x-docs-html
+$ zip -r /tmp/py2cairo-x.x.x-docs-html.zip py2cairo-x.x.x-docs-html
+$ chmod a+r /tmp/py2cairo*
untar docs in /tmp and check that they have correct version number and view
OK.
copy file to the 'releases' directory on cairo website:
- scp pycairo-xxx cairographics.org:/srv/cairo.freedesktop.org/www/releases
+ scp py2cairo-x.x.x-docs-html.tar.bz2 cairographics.org:/srv/cairo.freedesktop.org/www/releases
cd doc
html_docs_create.sh
diff --git a/doc/pycairo_c_api.rst b/doc/pycairo_c_api.rst
index 680b1c9..bf0e9e4 100644
--- a/doc/pycairo_c_api.rst
+++ b/doc/pycairo_c_api.rst
@@ -88,7 +88,7 @@ Functions
.. cfunction:: cairo_t * PycairoContext_GET(obj)
- get the C cairo_t * object out of the PycairoContext *obj
+ get the C cairo_t \* object out of the PycairoContext \*obj
.. cfunction:: PyObject * PycairoContext_FromContext(cairo_t *ctx, PyTypeObject *type, PyObject *base)
diff --git a/doc/reference/surfaces.rst b/doc/reference/surfaces.rst
index 9827514..261fc1e 100644
--- a/doc/reference/surfaces.rst
+++ b/doc/reference/surfaces.rst
@@ -649,15 +649,16 @@ The Win32PrintingSurface is a multi-page vector surface type.
class XCBSurface(:class:`Surface`)
-===================================
+==================================
The XCB surface is used to render cairo graphics to X Window System windows
and pixmaps using the XCB library.
-Note that the XCB surface automatically takes advantage of X render extension
-if it is available.
+Note that the XCB surface automatically takes advantage of the X render
+extension if it is available.
.. class:: XCBSurface
+
:param connection: an XCB connection
:param drawable: a X drawable
:param visualtype: a X visualtype
@@ -669,6 +670,7 @@ if it is available.
.. note:: This methods works using xpyb.
.. method:: set_size(width, height)
+
:param width: The width of the surface
:param height: The height of the surface
diff --git a/wscript b/wscript
index 2d631f8..ff01ffe 100644
--- a/wscript
+++ b/wscript
@@ -2,7 +2,7 @@
import os
-APPNAME='pycairo'
+APPNAME='py2cairo'
VERSION='1.8.11'
cairo_version_required = '1.8.10'
srcdir = '.'