From b0cfde9ded7da37b243fb8263378fb943de2006c Mon Sep 17 00:00:00 2001 From: Andreas Kloeckner <inform@tiker.net> Date: Sat, 12 Sep 2009 05:02:13 -0400 Subject: [PATCH] Minor doc fixes. --- doc/source/index.rst | 7 ++++--- doc/source/misc.rst | 6 +++--- doc/source/reference.rst | 8 ++++---- setup.py | 5 +++-- 4 files changed, 14 insertions(+), 12 deletions(-) diff --git a/doc/source/index.rst b/doc/source/index.rst index ba7ddd27..9bd36e1e 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -23,10 +23,11 @@ What makes PyOpenCL special? * Helpful Documentation. You're looking at it. ;) -* Liberal license. PyOpenCL is open-source and free for commercial, - academic, and private use. +* Liberal license. PyOpenCL is open-source under the + :ref:`MIT license <license>` + and free for commercial, academic, and private use. -Here's an example, to given you an impression:: +Here's an example, to give you an impression:: import pyopencl as cl import numpy diff --git a/doc/source/misc.rst b/doc/source/misc.rst index 0b06f942..1343d822 100644 --- a/doc/source/misc.rst +++ b/doc/source/misc.rst @@ -31,9 +31,7 @@ Version 0.91 * :meth:`pyopencl.MemoryObject.get_image_info` now actually exists. * Add :attr:`pyopencl.MemoryObject.image.info`. * Fix API tracing. -* Add constructor arguments to :class:`pyopencl.ImageFormat`. - (suggested by David Garcia) - +* Add constructor arguments to :class:`pyopencl.ImageFormat`. (suggested by David Garcia) Version 0.90.4 -------------- @@ -61,6 +59,8 @@ Version 0.90 * Initial release. +.. _license: + Licensing ========= diff --git a/doc/source/reference.rst b/doc/source/reference.rst index caa215e3..bb1976cd 100644 --- a/doc/source/reference.rst +++ b/doc/source/reference.rst @@ -223,6 +223,7 @@ Memory .. method:: get_gl_texture_info(param) See :class:`gl_texture_info` for values of *param*. Only available when PyOpenCL is compiled with GL support. See :func:`have_gl`. + |comparable| Buffers @@ -480,10 +481,9 @@ with GL support. See :func:`have_gl`. .. function:: enqueue_release_gl_objects(queue, mem_objects, wait_for=None) - *mem_objects* is a list of :class:`MemoryObject` instances. - |enqueue-waitfor| + *mem_objects* is a list of :class:`MemoryObject` instances. |enqueue-waitfor| .. seealso:: - * :meth:`MemoryObject.get_gl_object_info` - * :meth:`MemoryObject.get_gl_texture_info` + :meth:`MemoryObject.get_gl_object_info`, :meth:`MemoryObject.get_gl_texture_info`. + diff --git a/setup.py b/setup.py index 5543bded..7c4e45b1 100644 --- a/setup.py +++ b/setup.py @@ -105,8 +105,9 @@ def main(): * Helpful and complete `Documentation <http://documen.tician.de/pyopencl>`_ as well as a `Wiki <http://wiki.tiker.net/PyOpenCL>`_. - * Liberal license. PyOpenCL is open-source under the MIT license and - free for commercial, academic, and private use. + * Liberal license. PyOpenCL is open-source under the + `MIT license <http://en.wikipedia.org/wiki/MIT_License>`_ + and free for commercial, academic, and private use. * Broad support. PyOpenCL was tested and works with both AMD's and Nvidia's CL implementations. -- GitLab