Pillow/docs/index.rst

Pillow
======

Pillow is the friendly PIL fork by `Alex Clark and Contributors <https://github.com/python-pillow/Pillow/graphs/contributors>`_. PIL is the Python Imaging Library by Fredrik Lundh and Contributors.

.. image:: https://readthedocs.org/projects/pillow/badge/?version=latest
   :target: http://pillow.readthedocs.org/?badge=latest
   :alt: Documentation Status

.. image:: https://travis-ci.org/python-pillow/Pillow.svg?branch=master
   :target: https://travis-ci.org/python-pillow/Pillow
   :alt: Travis CI build status (Linux)

.. image:: https://travis-ci.org/python-pillow/pillow-wheels.svg?branch=latest
   :target: https://travis-ci.org/python-pillow/pillow-wheels
   :alt: Travis CI build status (OS X)

.. image:: https://img.shields.io/appveyor/ci/python-pillow/Pillow/master.svg?label=Windows%20build
   :target: https://ci.appveyor.com/project/python-pillow/Pillow
   :alt: AppVeyor CI build status (Windows)

.. image:: https://img.shields.io/pypi/v/pillow.svg
    :target: https://pypi.python.org/pypi/Pillow/
    :alt: Latest PyPI version

.. image:: https://img.shields.io/pypi/dm/pillow.svg
    :target: https://pypi.python.org/pypi/Pillow/
    :alt: Number of PyPI downloads

.. image:: https://coveralls.io/repos/python-pillow/Pillow/badge.svg?branch=master
  :target: https://coveralls.io/r/python-pillow/Pillow?branch=master
   :alt: Code coverage

.. image:: https://landscape.io/github/python-pillow/Pillow/master/landscape.svg
   :target: https://landscape.io/github/python-pillow/Pillow/master
   :alt: Code health

.. toctree::
   :maxdepth: 2

   installation.rst
   handbook/index.rst
   reference/index.rst
   porting.rst
   about.rst
   releasenotes/index.rst

.. raw:: html

    <a href="https://gratipay.com/pillow/">
      <img alt="Support via Gratipay" src="https://cdn.rawgit.com/gratipay/gratipay-badge/2.3.0/dist/gratipay.png"/>
    </a>

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
Fix alt text [ci skip] 2014-04-09 11:40:16 +04:00			`Pillow`
Wording 2014-03-18 00:57:03 +04:00			`======`
Fresh start for docs, generated by sphinx-apidoc 2013-04-12 21:52:50 +04:00
Wording [ci skip] Remove comments on "friendly PIL fork" 2015-09-29 16:53:07 +03:00			Pillow is the friendly PIL fork by `Alex Clark and Contributors <https://github.com/python-pillow/Pillow/graphs/contributors>`_. PIL is the Python Imaging Library by Fredrik Lundh and Contributors.
Add some main page info 2013-10-07 09:49:20 +04:00
Add docs badge [ci skip] Because more badges and the same badges duplicated in two places! (Maybe we only need badges in either the README.rst or docs/index.rst? Or maybe just we need to keep duplicating them. Not sure.) 2015-10-02 03:17:48 +03:00			`.. image:: https://readthedocs.org/projects/pillow/badge/?version=latest`
			`:target: http://pillow.readthedocs.org/?badge=latest`
			`:alt: Documentation Status`

Replace python-imaging with python-pillow (but yet not Coveralls) 2014-06-03 14:02:44 +04:00			`.. image:: https://travis-ci.org/python-pillow/Pillow.svg?branch=master`
			`:target: https://travis-ci.org/python-pillow/Pillow`
Update icons in docs [ci skip] 2015-04-03 22:29:28 +03:00			`:alt: Travis CI build status (Linux)`
Add some main page info 2013-10-07 09:49:20 +04:00
Reinstate OS X badge [CI skip] 2015-06-08 16:12:28 +03:00			`.. image:: https://travis-ci.org/python-pillow/pillow-wheels.svg?branch=latest`
			`:target: https://travis-ci.org/python-pillow/pillow-wheels`
			`:alt: Travis CI build status (OS X)`

Update AppVeyor URL accordingly [ci skip] c.f. #1468 2015-10-04 22:41:14 +03:00			`.. image:: https://img.shields.io/appveyor/ci/python-pillow/Pillow/master.svg?label=Windows%20build`
			`:target: https://ci.appveyor.com/project/python-pillow/Pillow`
Add AppVeyor badge [ci skip] 2015-10-04 13:53:00 +03:00			`:alt: AppVeyor CI build status (Windows)`

Shields.io badges instead of broken pypip.in. PNG->SVG for consistency [CI skip] 2015-06-08 15:02:28 +03:00			`.. image:: https://img.shields.io/pypi/v/pillow.svg`
Copy/move a bunch of README content to the doc site 2013-10-09 04:13:06 +04:00			`:target: https://pypi.python.org/pypi/Pillow/`
			`:alt: Latest PyPI version`

Shields.io badges instead of broken pypip.in. PNG->SVG for consistency [CI skip] 2015-06-08 15:02:28 +03:00			`.. image:: https://img.shields.io/pypi/dm/pillow.svg`
Copy/move a bunch of README content to the doc site 2013-10-09 04:13:06 +04:00			`:target: https://pypi.python.org/pypi/Pillow/`
			`:alt: Number of PyPI downloads`

Shields.io badges instead of broken pypip.in. PNG->SVG for consistency [CI skip] 2015-06-08 15:02:28 +03:00			`.. image:: https://coveralls.io/repos/python-pillow/Pillow/badge.svg?branch=master`
Update icons in docs [ci skip] 2015-04-03 22:29:28 +03:00			`:target: https://coveralls.io/r/python-pillow/Pillow?branch=master`
			`:alt: Code coverage`

Shields.io badges instead of broken pypip.in. PNG->SVG for consistency [CI skip] 2015-06-08 15:02:28 +03:00			`.. image:: https://landscape.io/github/python-pillow/Pillow/master/landscape.svg`
Update icons in docs [ci skip] 2015-04-03 22:29:28 +03:00			`:target: https://landscape.io/github/python-pillow/Pillow/master`
			`:alt: Code health`
SVG Travis, and Coverage badge in docs [ci skip] The SVG badge uses the Shields project for consistency with other projects' badges. More info: http://blog.travis-ci.com/2014-03-20-build-status-badges-support-svg/ 2014-04-09 11:33:13 +04:00
Fresh start for docs, generated by sphinx-apidoc 2013-04-12 21:52:50 +04:00			`.. toctree::`
Decrease ToC max depth to 2 2013-10-07 08:14:41 +04:00			`:maxdepth: 2`
Fresh start for docs, generated by sphinx-apidoc 2013-04-12 21:52:50 +04:00
Shorten title; Clarify these are rst files - Shorten "About Pillow" to Pillow (the reader likely already knows we're talking about Pillow) - Clarify reference to rst files by using rst extension; Sphinx seems to recognize either convention, but humans (like me) forget exactly what Sphinx is doing sometimes. 2015-09-30 13:21:52 +03:00			`installation.rst`
Clean up Handbook A while back somebody awesome forked the PIL Handbook (http://effbot.org/imagingbook/pil-index.htm) to Pillow. IIRC we tried to incorporate the handbook "seemlessly", which apparently meant not using the word "handbook" anywhere. Now that seems confusing, so I'm reorganizing all the handbook content under one section named "Handbook". This commit: - Moves guides.rst to handbook/index.rst - Moves appendices.rst to handbook/ - Removes developer.rst from handbook index. - Removes porting-pil-to-pillow.rst from handbook index. Unrelated to the above: - Shorten title "Porting existing PIL-based code to Pillow" to "Porting" - Move text "Porting existing PIL-based code to Pillow" to faux sub-header (bold text not sub-header because there's only one section.) "Porting" may be better named "Migrating", not sure yet. 2015-09-30 13:38:51 +03:00			`handbook/index.rst`
Fully document PIL.Image from handbook 2013-10-12 09:18:28 +04:00			`reference/index.rst`
Order swap and remove old ref 2015-09-30 14:33:16 +03:00			`porting.rst`
Shorten title; Clarify these are rst files - Shorten "About Pillow" to Pillow (the reader likely already knows we're talking about Pillow) - Clarify reference to rst files by using rst extension; Sphinx seems to recognize either convention, but humans (like me) forget exactly what Sphinx is doing sometimes. 2015-09-30 13:21:52 +03:00			`about.rst`
Ordering & remove plugins [ci skip] Ordering & remove plugins from list (moved to reference folder) 2015-10-01 18:02:56 +03:00			`releasenotes/index.rst`
Copy/move a bunch of README content to the doc site 2013-10-09 04:13:06 +04:00
Add Gratipay Badge [ci skip] Note: anyone on the GitHub Pillow Team interested in receiving donations for their contributions may do so via the Gratipay Pillow Team (https://gratipay.com/pillow/). I'm not sure how to add folks, but if you are interested I will figure it out (I'm currently the only recipient.) 2015-10-04 01:59:30 +03:00			`.. raw:: html`

s/aclark4life/pillow/ [ci skip] 2015-10-04 13:36:17 +03:00			`<a href="https://gratipay.com/pillow/">`
Add Gratipay Badge [ci skip] Note: anyone on the GitHub Pillow Team interested in receiving donations for their contributions may do so via the Gratipay Pillow Team (https://gratipay.com/pillow/). I'm not sure how to add folks, but if you are interested I will figure it out (I'm currently the only recipient.) 2015-10-04 01:59:30 +03:00			`<img alt="Support via Gratipay" src="https://cdn.rawgit.com/gratipay/gratipay-badge/2.3.0/dist/gratipay.png"/>`
			`</a>`

Fresh start for docs, generated by sphinx-apidoc 2013-04-12 21:52:50 +04:00			`Indices and tables`
			`==================`

			* :ref:`genindex`
			* :ref:`modindex`
			* :ref:`search`