[Python-modules-commits] [pilkit] 01/06: import pilkit_1.1.13.orig.tar.gz
Michael Fladischer
fladi at moszumanska.debian.org
Mon Dec 7 15:18:04 UTC 2015
This is an automated email from the git hooks/post-receive script.
fladi pushed a commit to branch master
in repository pilkit.
commit f86d431765f09978174a579d3b34f672ffa97b12
Author: Michael Fladischer <FladischerMichael at fladi.at>
Date: Mon Dec 7 14:47:48 2015 +0100
import pilkit_1.1.13.orig.tar.gz
---
AUTHORS | 39 +++
LICENSE | 27 ++
MANIFEST.in | 5 +
PKG-INFO | 121 ++++++++
README.rst | 101 +++++++
docs/Makefile | 153 ++++++++++
docs/make.bat | 190 ++++++++++++
docs/source/conf.py | 249 ++++++++++++++++
docs/source/index.rst | 22 ++
pilkit.egg-info/PKG-INFO | 121 ++++++++
pilkit.egg-info/SOURCES.txt | 44 +++
pilkit.egg-info/dependency_links.txt | 1 +
pilkit.egg-info/not-zip-safe | 1 +
pilkit.egg-info/top_level.txt | 1 +
pilkit/__init__.py | 3 +
pilkit/exceptions.py | 6 +
pilkit/lib.py | 35 +++
pilkit/pkgmeta.py | 5 +
pilkit/processors/__init__.py | 15 +
pilkit/processors/base.py | 225 ++++++++++++++
pilkit/processors/crop.py | 170 +++++++++++
pilkit/processors/resize.py | 274 +++++++++++++++++
pilkit/processors/utils.py | 18 ++
pilkit/utils.py | 357 +++++++++++++++++++++++
setup.cfg | 5 +
setup.py | 54 ++++
tests/__init__.py | 0
tests/__init__.pyc | Bin 0 -> 152 bytes
tests/__pycache__/__init__.cpython-32.pyc | Bin 0 -> 156 bytes
tests/__pycache__/__init__.cpython-33.pyc | Bin 0 -> 160 bytes
tests/__pycache__/test_processors.cpython-32.pyc | Bin 0 -> 8616 bytes
tests/__pycache__/test_processors.cpython-33.pyc | Bin 0 -> 9305 bytes
tests/__pycache__/test_utils.cpython-32.pyc | Bin 0 -> 4439 bytes
tests/__pycache__/test_utils.cpython-33.pyc | Bin 0 -> 4790 bytes
tests/__pycache__/utils.cpython-32.pyc | Bin 0 -> 942 bytes
tests/__pycache__/utils.cpython-33.pyc | Bin 0 -> 988 bytes
tests/assets/cat.gif | Bin 0 -> 27232 bytes
tests/assets/lenna-800x600-white-border.jpg | Bin 0 -> 202370 bytes
tests/assets/lenna-800x600.jpg | Bin 0 -> 211057 bytes
tests/assets/lenna.png | Bin 0 -> 473831 bytes
tests/test_processors.py | 151 ++++++++++
tests/test_processors.pyc | Bin 0 -> 7495 bytes
tests/test_utils.py | 84 ++++++
tests/test_utils.pyc | Bin 0 -> 3805 bytes
tests/utils.py | 19 ++
tests/utils.pyc | Bin 0 -> 870 bytes
46 files changed, 2496 insertions(+)
diff --git a/AUTHORS b/AUTHORS
new file mode 100644
index 0000000..2be9739
--- /dev/null
+++ b/AUTHORS
@@ -0,0 +1,39 @@
+Maintainers
+-----------
+
+* `Bryan Veloso`_
+* `Matthew Tretter`_
+* `Chris Drackett`_
+* `Greg Newman`_
+
+
+Contributors
+------------
+
+In addition to those listed on the `contributors page`__, the following people have
+also had a hand in bringing PILKit to life:
+
+* `Justin Driscoll`_
+* `Timothée Peignier`_
+* `Jan Sagemüller`_
+* `Alexander Bohn`_
+* `Eric Eldredge`_
+* `Germán M. Bravo`_
+* `Kevin Postal`_
+* `Madis Väin`_
+
+
+__ https://github.com/matthewwithanm/pilkit/graphs/contributors
+
+.. _Bryan Veloso: http://github.com/bryanveloso
+.. _Matthew Tretter: http://github.com/matthewwithanm
+.. _Chris Drackett: http://github.com/chrisdrackett
+.. _Greg Newman: http://github.com/gregnewman
+.. _Justin Driscoll: http://github.com/jdriscoll
+.. _Timothée Peignier: http://github.com/cyberdelia
+.. _Jan Sagemüller: https://github.com/version2
+.. _Alexander Bohn: http://github.com/fish2000
+.. _Eric Eldredge: http://github.com/lettertwo
+.. _Germán M. Bravo: http://github.com/Kronuz
+.. _Kevin Postal: https://github.com/kevinpostal
+.. _Madis Väin: https://github.com/madisvain
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..308c303
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,27 @@
+Copyright (c) 2013 Primary Maintainers
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+ 1. Redistributions of source code must retain the above copyright notice,
+ this list of conditions and the following disclaimer.
+
+ 2. Redistributions in binary form must reproduce the above copyright
+ notice, this list of conditions and the following disclaimer in the
+ documentation and/or other materials provided with the distribution.
+
+ 3. Neither the name of PILKit nor the names of its contributors
+ may be used to endorse or promote products derived from this software
+ without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
diff --git a/MANIFEST.in b/MANIFEST.in
new file mode 100644
index 0000000..67b0259
--- /dev/null
+++ b/MANIFEST.in
@@ -0,0 +1,5 @@
+include AUTHORS
+include LICENSE
+include README.rst
+recursive-include docs *
+recursive-include tests *
diff --git a/PKG-INFO b/PKG-INFO
new file mode 100644
index 0000000..bbf7157
--- /dev/null
+++ b/PKG-INFO
@@ -0,0 +1,121 @@
+Metadata-Version: 1.1
+Name: pilkit
+Version: 1.1.13
+Summary: A collection of utilities and processors for the Python Imaging Libary.
+Home-page: http://github.com/matthewwithanm/pilkit/
+Author: Matthew Tretter
+Author-email: m at tthewwithanm.com
+License: BSD
+Description: PILKit is a collection of utilities for working with PIL (the Python Imaging
+ Library).
+
+ One of its main features is a set of **processors** which expose a simple
+ interface for performing manipulations on PIL images.
+
+ Looking for more advanced processors? Check out `Instakit`_!
+
+ **For the complete documentation on the latest stable version of PILKit, see**
+ `PILKit on RTD`_.
+
+ .. image:: https://api.travis-ci.org/matthewwithanm/pilkit.png
+
+ .. _`PILKit on RTD`: http://pilkit.readthedocs.org
+ .. _`Instakit`: https://github.com/fish2000/instakit
+
+
+ Installation
+ ============
+
+ 1. Install `PIL`_ or `Pillow`_.
+ 2. Run ``pip install pilkit`` (or clone the source and put the pilkit module on
+ your path)
+
+ .. note:: If you've never seen Pillow before, it considers itself a
+ more-frequently updated "friendly" fork of PIL that's compatible with
+ setuptools. As such, it shares the same namespace as PIL does and is a
+ drop-in replacement.
+
+ .. _`PIL`: http://pypi.python.org/pypi/PIL
+ .. _`Pillow`: http://pypi.python.org/pypi/Pillow
+
+
+ Usage Overview
+ ==============
+
+
+ Processors
+ ----------
+
+ The "pilkit.processors" module contains several classes for processing PIL
+ images, which provide an easy to understand API:
+
+ .. code-block:: python
+
+ from pilkit.processors import ResizeToFit
+
+ img = Image.open('/path/to/my/image.png')
+ processor = ResizeToFit(100, 100)
+ new_img = processor.process(img)
+
+ A few of the included processors are:
+
+ * ``ResizeToFit``
+ * ``ResizeToFill``
+ * ``SmartResize``
+ * ``Adjust``
+ * ``TrimBorderColor``
+ * ``Transpose``
+
+ There's also a ``ProcessorPipeline`` class for executing processors
+ sequentially:
+
+ .. code-block:: python
+
+ from pilkit.processors import ProcessorPipeline, ResizeToFit, Adjust
+
+ img = Image.open('/path/to/my/image.png')
+ processor = ProcessorPipeline([Adjust(color=0), ResizeToFit(100, 100)])
+ new_image = processor.process(img)
+
+
+ Utilities
+ ---------
+
+ In addition to the processors, PILKit contains a few utilities to ease the pain
+ of working with PIL. Some examples:
+
+ ``prepare_image``
+ Prepares the image for saving to the provided format by doing some
+ common-sense conversions, including preserving transparency and quantizing.
+ ``save_image``
+ Wraps PIL's ``Image.save()`` method in order to gracefully handle PIL's
+ "Suspension not allowed here" errors, and (optionally) prepares the image
+ using ``prepare_image``
+
+ Utilities are also included for converting between formats, extensions, and
+ mimetypes.
+
+
+ Community
+ =========
+
+ Please use `the GitHub issue tracker <https://github.com/matthewwithanm/pilkit/issues>`_
+ to report bugs. `A mailing list <https://groups.google.com/forum/#!forum/django-imagekit>`_
+ also exists to discuss the project and ask questions, as well as the official
+ `#imagekit <irc://irc.freenode.net/imagekit>`_ channel on Freenode. (Both of
+ these are shared with the `django-imagekit`_ project—from which PILKit spun
+ off.)
+
+ .. _`django-imagekit`: https://github.com/jdriscoll/django-imagekit
+
+Platform: UNKNOWN
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 2.5
+Classifier: Programming Language :: Python :: 2.6
+Classifier: Programming Language :: Python :: 2.7
+Classifier: Programming Language :: Python :: 3.2
+Classifier: Programming Language :: Python :: 3.3
+Classifier: Topic :: Utilities
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..705b609
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,101 @@
+PILKit is a collection of utilities for working with PIL (the Python Imaging
+Library).
+
+One of its main features is a set of **processors** which expose a simple
+interface for performing manipulations on PIL images.
+
+Looking for more advanced processors? Check out `Instakit`_!
+
+**For the complete documentation on the latest stable version of PILKit, see**
+`PILKit on RTD`_.
+
+.. image:: https://api.travis-ci.org/matthewwithanm/pilkit.png
+
+.. _`PILKit on RTD`: http://pilkit.readthedocs.org
+.. _`Instakit`: https://github.com/fish2000/instakit
+
+
+Installation
+============
+
+1. Install `PIL`_ or `Pillow`_.
+2. Run ``pip install pilkit`` (or clone the source and put the pilkit module on
+ your path)
+
+.. note:: If you've never seen Pillow before, it considers itself a
+ more-frequently updated "friendly" fork of PIL that's compatible with
+ setuptools. As such, it shares the same namespace as PIL does and is a
+ drop-in replacement.
+
+.. _`PIL`: http://pypi.python.org/pypi/PIL
+.. _`Pillow`: http://pypi.python.org/pypi/Pillow
+
+
+Usage Overview
+==============
+
+
+Processors
+----------
+
+The "pilkit.processors" module contains several classes for processing PIL
+images, which provide an easy to understand API:
+
+.. code-block:: python
+
+ from pilkit.processors import ResizeToFit
+
+ img = Image.open('/path/to/my/image.png')
+ processor = ResizeToFit(100, 100)
+ new_img = processor.process(img)
+
+A few of the included processors are:
+
+* ``ResizeToFit``
+* ``ResizeToFill``
+* ``SmartResize``
+* ``Adjust``
+* ``TrimBorderColor``
+* ``Transpose``
+
+There's also a ``ProcessorPipeline`` class for executing processors
+sequentially:
+
+.. code-block:: python
+
+ from pilkit.processors import ProcessorPipeline, ResizeToFit, Adjust
+
+ img = Image.open('/path/to/my/image.png')
+ processor = ProcessorPipeline([Adjust(color=0), ResizeToFit(100, 100)])
+ new_image = processor.process(img)
+
+
+Utilities
+---------
+
+In addition to the processors, PILKit contains a few utilities to ease the pain
+of working with PIL. Some examples:
+
+``prepare_image``
+ Prepares the image for saving to the provided format by doing some
+ common-sense conversions, including preserving transparency and quantizing.
+``save_image``
+ Wraps PIL's ``Image.save()`` method in order to gracefully handle PIL's
+ "Suspension not allowed here" errors, and (optionally) prepares the image
+ using ``prepare_image``
+
+Utilities are also included for converting between formats, extensions, and
+mimetypes.
+
+
+Community
+=========
+
+Please use `the GitHub issue tracker <https://github.com/matthewwithanm/pilkit/issues>`_
+to report bugs. `A mailing list <https://groups.google.com/forum/#!forum/django-imagekit>`_
+also exists to discuss the project and ask questions, as well as the official
+`#imagekit <irc://irc.freenode.net/imagekit>`_ channel on Freenode. (Both of
+these are shared with the `django-imagekit`_ project—from which PILKit spun
+off.)
+
+.. _`django-imagekit`: https://github.com/jdriscoll/django-imagekit
diff --git a/docs/Makefile b/docs/Makefile
new file mode 100644
index 0000000..5f83b2b
--- /dev/null
+++ b/docs/Makefile
@@ -0,0 +1,153 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS =
+SPHINXBUILD = sphinx-build
+PAPER =
+BUILDDIR = build
+
+# Internal variables.
+PAPEROPT_a4 = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
+
+help:
+ @echo "Please use \`make <target>' where <target> is one of"
+ @echo " html to make standalone HTML files"
+ @echo " dirhtml to make HTML files named index.html in directories"
+ @echo " singlehtml to make a single large HTML file"
+ @echo " pickle to make pickle files"
+ @echo " json to make JSON files"
+ @echo " htmlhelp to make HTML files and a HTML help project"
+ @echo " qthelp to make HTML files and a qthelp project"
+ @echo " devhelp to make HTML files and a Devhelp project"
+ @echo " epub to make an epub"
+ @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+ @echo " latexpdf to make LaTeX files and run them through pdflatex"
+ @echo " text to make text files"
+ @echo " man to make manual pages"
+ @echo " texinfo to make Texinfo files"
+ @echo " info to make Texinfo files and run them through makeinfo"
+ @echo " gettext to make PO message catalogs"
+ @echo " changes to make an overview of all changed/added/deprecated items"
+ @echo " linkcheck to check all external links for integrity"
+ @echo " doctest to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+ -rm -rf $(BUILDDIR)/*
+
+html:
+ $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+ $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+ $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+ @echo
+ @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+ $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+ @echo
+ @echo "Build finished; now you can process the pickle files."
+
+json:
+ $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+ @echo
+ @echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+ $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+ @echo
+ @echo "Build finished; now you can run HTML Help Workshop with the" \
+ ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+ $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+ @echo
+ @echo "Build finished; now you can run "qcollectiongenerator" with the" \
+ ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+ @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/PILKit.qhcp"
+ @echo "To view the help file:"
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/PILKit.qhc"
+
+devhelp:
+ $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+ @echo
+ @echo "Build finished."
+ @echo "To view the help file:"
+ @echo "# mkdir -p $$HOME/.local/share/devhelp/PILKit"
+ @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/PILKit"
+ @echo "# devhelp"
+
+epub:
+ $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+ @echo
+ @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo
+ @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+ @echo "Run \`make' in that directory to run these through (pdf)latex" \
+ "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo "Running LaTeX files through pdflatex..."
+ $(MAKE) -C $(BUILDDIR)/latex all-pdf
+ @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+ $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+ @echo
+ @echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+ $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+ @echo
+ @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+texinfo:
+ $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+ @echo
+ @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+ @echo "Run \`make' in that directory to run these through makeinfo" \
+ "(use \`make info' here to do that automatically)."
+
+info:
+ $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+ @echo "Running Texinfo files through makeinfo..."
+ make -C $(BUILDDIR)/texinfo info
+ @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+ $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+ @echo
+ @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+changes:
+ $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+ @echo
+ @echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+ $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+ @echo
+ @echo "Link check complete; look for any errors in the above output " \
+ "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+ $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+ @echo "Testing of doctests in the sources finished, look at the " \
+ "results in $(BUILDDIR)/doctest/output.txt."
diff --git a/docs/make.bat b/docs/make.bat
new file mode 100644
index 0000000..6706cc4
--- /dev/null
+++ b/docs/make.bat
@@ -0,0 +1,190 @@
+ at ECHO OFF
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+ set SPHINXBUILD=sphinx-build
+)
+set BUILDDIR=build
+set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% source
+set I18NSPHINXOPTS=%SPHINXOPTS% source
+if NOT "%PAPER%" == "" (
+ set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
+ set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
+)
+
+if "%1" == "" goto help
+
+if "%1" == "help" (
+ :help
+ echo.Please use `make ^<target^>` where ^<target^> is one of
+ echo. html to make standalone HTML files
+ echo. dirhtml to make HTML files named index.html in directories
+ echo. singlehtml to make a single large HTML file
+ echo. pickle to make pickle files
+ echo. json to make JSON files
+ echo. htmlhelp to make HTML files and a HTML help project
+ echo. qthelp to make HTML files and a qthelp project
+ echo. devhelp to make HTML files and a Devhelp project
+ echo. epub to make an epub
+ echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter
+ echo. text to make text files
+ echo. man to make manual pages
+ echo. texinfo to make Texinfo files
+ echo. gettext to make PO message catalogs
+ echo. changes to make an overview over all changed/added/deprecated items
+ echo. linkcheck to check all external links for integrity
+ echo. doctest to run all doctests embedded in the documentation if enabled
+ goto end
+)
+
+if "%1" == "clean" (
+ for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
+ del /q /s %BUILDDIR%\*
+ goto end
+)
+
+if "%1" == "html" (
+ %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The HTML pages are in %BUILDDIR%/html.
+ goto end
+)
+
+if "%1" == "dirhtml" (
+ %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
+ goto end
+)
+
+if "%1" == "singlehtml" (
+ %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
+ goto end
+)
+
+if "%1" == "pickle" (
+ %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished; now you can process the pickle files.
+ goto end
+)
+
+if "%1" == "json" (
+ %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished; now you can process the JSON files.
+ goto end
+)
+
+if "%1" == "htmlhelp" (
+ %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished; now you can run HTML Help Workshop with the ^
+.hhp project file in %BUILDDIR%/htmlhelp.
+ goto end
+)
+
+if "%1" == "qthelp" (
+ %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished; now you can run "qcollectiongenerator" with the ^
+.qhcp project file in %BUILDDIR%/qthelp, like this:
+ echo.^> qcollectiongenerator %BUILDDIR%\qthelp\PILKit.qhcp
+ echo.To view the help file:
+ echo.^> assistant -collectionFile %BUILDDIR%\qthelp\PILKit.ghc
+ goto end
+)
+
+if "%1" == "devhelp" (
+ %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished.
+ goto end
+)
+
+if "%1" == "epub" (
+ %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The epub file is in %BUILDDIR%/epub.
+ goto end
+)
+
+if "%1" == "latex" (
+ %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
+ goto end
+)
+
+if "%1" == "text" (
+ %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The text files are in %BUILDDIR%/text.
+ goto end
+)
+
+if "%1" == "man" (
+ %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The manual pages are in %BUILDDIR%/man.
+ goto end
+)
+
+if "%1" == "texinfo" (
+ %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
+ goto end
+)
+
+if "%1" == "gettext" (
+ %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
+ goto end
+)
+
+if "%1" == "changes" (
+ %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.The overview file is in %BUILDDIR%/changes.
+ goto end
+)
+
+if "%1" == "linkcheck" (
+ %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Link check complete; look for any errors in the above output ^
+or in %BUILDDIR%/linkcheck/output.txt.
+ goto end
+)
+
+if "%1" == "doctest" (
+ %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Testing of doctests in the sources finished, look at the ^
+results in %BUILDDIR%/doctest/output.txt.
+ goto end
+)
+
+:end
diff --git a/docs/source/conf.py b/docs/source/conf.py
new file mode 100644
index 0000000..8dbfc1a
--- /dev/null
+++ b/docs/source/conf.py
@@ -0,0 +1,249 @@
+# -*- coding: utf-8 -*-
+#
+# PILKit documentation build configuration file, created by
+# sphinx-quickstart on Thu Feb 7 20:01:22 2013.
+#
+# This file is execfile()d with the current directory set to its containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import re, sys, os
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#sys.path.insert(0, os.path.abspath('.'))
+
+# -- General configuration -----------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be extensions
+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = []
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'PILKit'
+copyright = u'2013, Matthew Tretter'
+
+pkgmeta = {}
+pkgmeta_file = os.path.join(os.path.dirname(__file__), '..', '..', 'pilkit',
+ 'pkgmeta.py')
+with open(pkgmeta_file) as f:
+ code = compile(f.read(), 'pkgmeta.py', 'exec')
+ exec(code, pkgmeta)
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = re.match('\d+\.\d+', pkgmeta['__version__']).group()
+# The full version, including alpha/beta/rc tags.
+release = pkgmeta['__version__']
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = []
+
+# The reST default role (used for this markup: `text`) to use for all documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+
+# -- Options for HTML output ---------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages. See the documentation for
+# a list of builtin themes.
+html_theme = 'default'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further. For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents. If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar. Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it. The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'PILKitdoc'
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+latex_elements = {
+# The paper size ('letterpaper' or 'a4paper').
+#'papersize': 'letterpaper',
+
+# The font size ('10pt', '11pt' or '12pt').
+#'pointsize': '10pt',
+
+# Additional stuff for the LaTeX preamble.
+#'preamble': '',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+ ('index', 'PILKit.tex', u'PILKit Documentation',
+ u'Matthew Tretter', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output --------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+ ('index', 'pilkit', u'PILKit Documentation',
+ [u'Matthew Tretter'], 1)
+]
+
+# If true, show URL addresses after external links.
+#man_show_urls = False
+
+
+# -- Options for Texinfo output ------------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+# dir menu entry, description, category)
+texinfo_documents = [
+ ('index', 'PILKit', u'PILKit Documentation',
+ u'Matthew Tretter', 'PILKit', 'One line description of project.',
+ 'Miscellaneous'),
+]
+
+# Documents to append as an appendix to all manuals.
+#texinfo_appendices = []
+
+# If false, no module index is generated.
+#texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#texinfo_show_urls = 'footnote'
diff --git a/docs/source/index.rst b/docs/source/index.rst
new file mode 100644
index 0000000..d4ece72
--- /dev/null
+++ b/docs/source/index.rst
@@ -0,0 +1,22 @@
+
+Welcome to PILKit's documentation!
+==================================
+
+.. include:: ../../README.rst
+
+
... 1792 lines suppressed ...
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/python-modules/packages/pilkit.git
More information about the Python-modules-commits
mailing list