From aa263857f3a4b0bdcc5888a2528a5167f8648f23 Mon Sep 17 00:00:00 2001 From: Alex Clark Date: Wed, 30 Sep 2015 06:38:51 -0400 Subject: [PATCH] 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. --- README.rst | 2 +- docs/Makefile | 3 +++ docs/guides.rst | 11 ----------- docs/handbook/index.rst | 10 ++++++++++ docs/index.rst | 3 +-- docs/porting-pil-to-pillow.rst | 6 ++++-- 6 files changed, 19 insertions(+), 16 deletions(-) delete mode 100644 docs/guides.rst create mode 100644 docs/handbook/index.rst diff --git a/README.rst b/README.rst index d5e23a3d8..6e0f6ef52 100644 --- a/README.rst +++ b/README.rst @@ -40,7 +40,7 @@ More Information - `Documentation `_ - `Installation `_ - - `Guides `_ + - `Handbook `_ - `Contribute `_ diff --git a/docs/Makefile b/docs/Makefile index f28f802a1..1a912039e 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -154,3 +154,6 @@ doctest: livehtml: html livereload $(BUILDDIR)/html -p 33233 + +serve: + cd $(BUILDDIR)/html; python -m SimpleHTTPServer diff --git a/docs/guides.rst b/docs/guides.rst deleted file mode 100644 index 87ce75bd4..000000000 --- a/docs/guides.rst +++ /dev/null @@ -1,11 +0,0 @@ -Guides -====== - -.. toctree:: - :maxdepth: 2 - - handbook/overview - handbook/tutorial - handbook/concepts - porting-pil-to-pillow - developer diff --git a/docs/handbook/index.rst b/docs/handbook/index.rst new file mode 100644 index 000000000..acdeff7db --- /dev/null +++ b/docs/handbook/index.rst @@ -0,0 +1,10 @@ +Handbook +======== + +.. toctree:: + :maxdepth: 2 + + overview + tutorial + concepts + appendices diff --git a/docs/index.rst b/docs/index.rst index 103b21a13..4a19630b1 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -31,9 +31,8 @@ Pillow is the friendly PIL fork by `Alex Clark and Contributors