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.
This commit is contained in:
Alex Clark 2015-09-30 06:38:51 -04:00
parent edb238f4e5
commit aa263857f3
6 changed files with 19 additions and 16 deletions

View File

@ -40,7 +40,7 @@ More Information
- `Documentation <https://pillow.readthedocs.org/>`_ - `Documentation <https://pillow.readthedocs.org/>`_
- `Installation <https://pillow.readthedocs.org/installation.html>`_ - `Installation <https://pillow.readthedocs.org/installation.html>`_
- `Guides <https://pillow.readthedocs.org/guides.html>`_ - `Handbook <https://pillow.readthedocs.org/handbook/index.html>`_
- `Contribute <https://github.com/python-pillow/Pillow/blob/master/CONTRIBUTING.md>`_ - `Contribute <https://github.com/python-pillow/Pillow/blob/master/CONTRIBUTING.md>`_

View File

@ -154,3 +154,6 @@ doctest:
livehtml: html livehtml: html
livereload $(BUILDDIR)/html -p 33233 livereload $(BUILDDIR)/html -p 33233
serve:
cd $(BUILDDIR)/html; python -m SimpleHTTPServer

View File

@ -1,11 +0,0 @@
Guides
======
.. toctree::
:maxdepth: 2
handbook/overview
handbook/tutorial
handbook/concepts
porting-pil-to-pillow
developer

10
docs/handbook/index.rst Normal file
View File

@ -0,0 +1,10 @@
Handbook
========
.. toctree::
:maxdepth: 2
overview
tutorial
concepts
appendices

View File

@ -31,9 +31,8 @@ Pillow is the friendly PIL fork by `Alex Clark and Contributors <https://github.
:maxdepth: 2 :maxdepth: 2
installation.rst installation.rst
guides.rst handbook/index.rst
reference/index.rst reference/index.rst
handbook/appendices.rst
releasenotes/index.rst releasenotes/index.rst
about.rst about.rst

View File

@ -1,5 +1,7 @@
Porting existing PIL-based code to Pillow Porting
========================================= =======
**Porting existing PIL-based code to Pillow**
Pillow is a functional drop-in replacement for the Python Imaging Library. To Pillow is a functional drop-in replacement for the Python Imaging Library. To
run your existing PIL-compatible code with Pillow, it needs to be modified to run your existing PIL-compatible code with Pillow, it needs to be modified to