Skip to content

Commit

Permalink
rst cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
Paweł Piotr Przeradowski committed Sep 7, 2013
1 parent d62c742 commit 7317d7b
Show file tree
Hide file tree
Showing 6 changed files with 25 additions and 28 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,5 @@ dob/build

tool/downloads
tool/data.py

*.spl
3 changes: 3 additions & 0 deletions .vim/en.utf-8.add
Original file line number Diff line number Diff line change
@@ -1 +1,4 @@
Pystacia
McDonough
Rochaster
Reitz
2 changes: 1 addition & 1 deletion doc/source/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ API Documentation

.. toctree::
:maxdepth: 1

api/pystacia
api/image
api/color
Expand Down
6 changes: 3 additions & 3 deletions doc/source/color.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Working with color
==================

Couple of methods in Pystacia use color as argument. There are many ways to
factory a color in Pystcia. All the machinery is defined in :mod:`pystcia.color`
factory a color in Pystacia. All the machinery is defined in :mod:`pystcia.color`
As a convention all the channel information for red, blue, green, alpha and so on
is specified as ``float`` numbers between `0` and `1`. It can be misleading
for people used to thinking in 8-bit 0-255 mode. Pystacia uses ``float`` because
Expand Down Expand Up @@ -105,7 +105,7 @@ and :meth:`pystacia.color.Color.get_rgba`:
>>> red.get_rgba()
(1, 1, 1, 0.1)

To return value CSS3 string representation of color use :meth:`pystacia.color.Color.get_string`
To return value :term:`CSS3` string representation of color use :meth:`pystacia.color.Color.get_string`
or cast instance with :func:`str`:

>>> red.get_string()
Expand All @@ -129,4 +129,4 @@ False
>>> transparent.opaque
False
>>> transparent.transparent
True
True
23 changes: 8 additions & 15 deletions doc/source/copyright.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,10 @@ Copyright, Trademarks, and Attributions
=======================================

*The Pystacia image manipulation library, Version 0.2*
by `Paweł Piotr Przeradowski <http://twitter.com/squeaky_pl>`_

No ponies were harmed during development of this software.

by `Paweł Piotr Przeradowski <http://gplus.to/przeradowski>`_

All rights reserved. This material may be copied or distributed only
subject to the terms and conditions set forth in the `Creative Commons
Attribution-Noncommercial-Share Alike 3.0 United States License
Expand All @@ -18,12 +17,12 @@ similar license to this one.

.. note::

While the Pystacia documentation is offered under the
Creative Commons Attribution-Nonconmmercial-Share Alike 3.0 United
States License, the Pystacia *software* is offered under a
`less restrictive MIT license
<http://www.opensource.org/licenses/mit-license.php>`_ . It's completely
free of charge both for open-source and commercial project use.
While the Pystacia documentation is offered under the
Creative Commons Attribution-Noncommercial-Share Alike 3.0 United
States License, the Pystacia *software* is offered under a
`less restrictive MIT license
<http://www.opensource.org/licenses/mit-license.php>`_ . It's completely
free of charge both for open-source and commercial project use.

All terms mentioned in this documentation that are known to be trademarks or
service marks have been appropriately capitalized. However, use of a
Expand All @@ -42,7 +41,7 @@ This software relies on :term:`ImageMagick` for its internal operation.
:term:`ImageMagick` is licensed under the
`ImageMagick License <http://www.imagemagick.org/script/license.php>`_.

Logo image is a derivative work based on image by user Ckim06 used in Wikipedia that can
Logo image is a derivative work based on image by user ``Ckim06`` used in Wikipedia that can
be found here: http://kk.wikipedia.org/wiki/%D0%A1%D1%83%D1%80%D0%B5%D1%82:PistachGrp_001_LR.jpg.
Image is released into public domain.

Expand All @@ -52,9 +51,3 @@ General documentation structure and many paragraphs were adapted from
Documentation theme is based on
`Flask theme <https://github.com/mitsuhiko/flask-sphinx-themes/blob/master/LICENSE>`_
by Armin Rochaster later adapted by Kenneth Reitz for :term:`Requests` project.

Attributions
------------

- Bobby Drake - the first production adaption of the library and editing of
this document he never did.
17 changes: 8 additions & 9 deletions doc/source/index.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
===============================================
================================================
The «Pystacia» raster image manipulation library
===============================================
================================================

Pystacia is a new image manipulation library written to meet practical
needs of developers. It's simple, it's cross-platform, runs on Python 2.5+, 3.x,
:term:`PyPy` and :term:`IronPython`. It's compact but still appropriate for most of your
day to day image handling tasks. Pystacia leverages powerful :term:`ImageMagick`
library as a back-end exposing easily comprehensible pythonic API.
library as a back-end exposing easily comprehensible pythonic :term:`API`.

Here is one of the simplest code snippets showing what you can do with it:

Expand All @@ -19,7 +19,7 @@ When saved to ``simple.py``, the above script can be run via:
$ pip install pystacia
$ python simple.py
Provided you have file example.png in the same directory it would output
Provided you have file ``example.png`` in the same directory it would output
version of the file which would be scaled to 320╳240 pixels and rotated by 30
degrees. It would also display it in your default system image viewing
program.
Expand All @@ -29,23 +29,23 @@ What's new

.. toctree::
:maxdepth: 1

whatsnew/0.2

Front matter
============

.. toctree::
:maxdepth: 1

copyright

Narrative documentation
=======================

.. toctree::
:maxdepth: 2

introduction
installation
image
Expand All @@ -56,7 +56,7 @@ Narrative documentation
Reference Material
==================

Reference material includes documentation for Pystacia API.
Reference material includes documentation for Pystacia :term:`API`.

.. toctree::
:maxdepth: 2
Expand All @@ -69,4 +69,3 @@ Indices and tables
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

0 comments on commit 7317d7b

Please sign in to comment.