From eabaef12fa2336bfae622dc99c93251b35a65b16 Mon Sep 17 00:00:00 2001 From: Alex Clark Date: Wed, 30 Sep 2015 06:16:55 -0400 Subject: [PATCH 01/14] Remove pre-fork-readme This exists here *too* and we probably don't need two copies: https://github.com/python-pillow/Pillow/blob/master/CHANGES.rst#pre-fork. Hence, this one can be removed. --- docs/index.rst | 1 - docs/pre-fork-readme.rst | 306 --------------------------------------- 2 files changed, 307 deletions(-) delete mode 100644 docs/pre-fork-readme.rst diff --git a/docs/index.rst b/docs/index.rst index 5b0a5d4af..93d9bbd64 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -36,7 +36,6 @@ Pillow is the friendly PIL fork by `Alex Clark and Contributors Date: Wed, 30 Sep 2015 06:21:52 -0400 Subject: [PATCH 02/14] 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. --- docs/about.rst | 4 ++-- docs/index.rst | 8 ++++---- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/about.rst b/docs/about.rst index 67bf20481..a36fe2c2a 100644 --- a/docs/about.rst +++ b/docs/about.rst @@ -1,5 +1,5 @@ -About Pillow -============ +About +===== Goals ----- diff --git a/docs/index.rst b/docs/index.rst index 93d9bbd64..103b21a13 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -30,12 +30,12 @@ Pillow is the friendly PIL fork by `Alex Clark and Contributors Date: Wed, 30 Sep 2015 06:38:51 -0400 Subject: [PATCH 03/14] 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 Date: Wed, 30 Sep 2015 06:56:48 -0400 Subject: [PATCH 04/14] Create developer section - Move release notes & porting info to developer section --- docs/{developer.rst => developer/index.rst} | 9 ++++++++- docs/{ => developer}/porting-pil-to-pillow.rst | 0 docs/{ => developer}/releasenotes/2.7.0.rst | 0 docs/{ => developer}/releasenotes/2.8.0.rst | 0 docs/{ => developer}/releasenotes/index.rst | 0 docs/index.rst | 2 ++ 6 files changed, 10 insertions(+), 1 deletion(-) rename docs/{developer.rst => developer/index.rst} (80%) rename docs/{ => developer}/porting-pil-to-pillow.rst (100%) rename docs/{ => developer}/releasenotes/2.7.0.rst (100%) rename docs/{ => developer}/releasenotes/2.8.0.rst (100%) rename docs/{ => developer}/releasenotes/index.rst (100%) diff --git a/docs/developer.rst b/docs/developer/index.rst similarity index 80% rename from docs/developer.rst rename to docs/developer/index.rst index ea3b0f05e..91f00cb45 100644 --- a/docs/developer.rst +++ b/docs/developer/index.rst @@ -3,7 +3,6 @@ Developer .. Note:: When committing only trivial changes, please include [ci skip] in the commit message to avoid running tests on Travis-CI. Thank you! - Release ------- @@ -15,3 +14,11 @@ Version number The version number is currently stored in 3 places:: PIL/__init__.py _imaging.c setup.py + +Release notes +------------- + +.. toctree:: + :maxdepth: 2 + + releasenotes/index.rst diff --git a/docs/porting-pil-to-pillow.rst b/docs/developer/porting-pil-to-pillow.rst similarity index 100% rename from docs/porting-pil-to-pillow.rst rename to docs/developer/porting-pil-to-pillow.rst diff --git a/docs/releasenotes/2.7.0.rst b/docs/developer/releasenotes/2.7.0.rst similarity index 100% rename from docs/releasenotes/2.7.0.rst rename to docs/developer/releasenotes/2.7.0.rst diff --git a/docs/releasenotes/2.8.0.rst b/docs/developer/releasenotes/2.8.0.rst similarity index 100% rename from docs/releasenotes/2.8.0.rst rename to docs/developer/releasenotes/2.8.0.rst diff --git a/docs/releasenotes/index.rst b/docs/developer/releasenotes/index.rst similarity index 100% rename from docs/releasenotes/index.rst rename to docs/developer/releasenotes/index.rst diff --git a/docs/index.rst b/docs/index.rst index 4a19630b1..2ecb7d123 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -34,7 +34,9 @@ Pillow is the friendly PIL fork by `Alex Clark and Contributors Date: Wed, 30 Sep 2015 07:24:58 -0400 Subject: [PATCH 05/14] Remove extra header --- docs/developer/releasenotes/index.rst | 3 --- 1 file changed, 3 deletions(-) diff --git a/docs/developer/releasenotes/index.rst b/docs/developer/releasenotes/index.rst index d70edc54d..39814d23f 100644 --- a/docs/developer/releasenotes/index.rst +++ b/docs/developer/releasenotes/index.rst @@ -1,6 +1,3 @@ -Release Notes -============= - .. note:: Contributors please include release notes as needed or appropriate with your bug fixes, feature additions and tests. .. toctree:: From e85d058f07390dc1ce359692eb908e3d8d3913f9 Mon Sep 17 00:00:00 2001 From: Alex Clark Date: Wed, 30 Sep 2015 07:27:02 -0400 Subject: [PATCH 06/14] Add RTD blurb --- docs/developer/index.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/developer/index.rst b/docs/developer/index.rst index 91f00cb45..19f823ee6 100644 --- a/docs/developer/index.rst +++ b/docs/developer/index.rst @@ -15,6 +15,12 @@ The version number is currently stored in 3 places:: PIL/__init__.py _imaging.c setup.py + +Readthedocs +~~~~~~~~~~~ + +Make sure the default version for Readthedocs is the latest release version e.g. 3.0.0 not latest. + Release notes ------------- From 7ff78543c86dc5be599a1bf7ebc9111bb014e3cb Mon Sep 17 00:00:00 2001 From: Alex Clark Date: Wed, 30 Sep 2015 07:28:35 -0400 Subject: [PATCH 07/14] Port to the top As "how to port" (make code written for PIL work with Pillow) is likely a FAQ, back to the top. --- docs/index.rst | 1 + docs/{developer/porting-pil-to-pillow.rst => porting.rst} | 0 2 files changed, 1 insertion(+) rename docs/{developer/porting-pil-to-pillow.rst => porting.rst} (100%) diff --git a/docs/index.rst b/docs/index.rst index 2ecb7d123..8cadaebd4 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -33,6 +33,7 @@ Pillow is the friendly PIL fork by `Alex Clark and Contributors Date: Wed, 30 Sep 2015 07:31:06 -0400 Subject: [PATCH 08/14] Move Plugins to Reference Plugin references were previously unlinked AFAICT, now moved to references/ and linked from references index. (I'm not sure I fully understand or can recall if these API references are generated once then updated or generated each time via `make html` ?) --- docs/reference/index.rst | 1 + docs/{ => reference}/plugins.rst | 0 2 files changed, 1 insertion(+) rename docs/{ => reference}/plugins.rst (100%) diff --git a/docs/reference/index.rst b/docs/reference/index.rst index 2d89d2100..555bd2a57 100644 --- a/docs/reference/index.rst +++ b/docs/reference/index.rst @@ -32,3 +32,4 @@ Reference PixelAccess PyAccess ../PIL + plugins diff --git a/docs/plugins.rst b/docs/reference/plugins.rst similarity index 100% rename from docs/plugins.rst rename to docs/reference/plugins.rst From b65c170b22b605583360a28abff597f80cde991f Mon Sep 17 00:00:00 2001 From: Alex Clark Date: Wed, 30 Sep 2015 07:33:16 -0400 Subject: [PATCH 09/14] Order swap and remove old ref --- docs/index.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index 8cadaebd4..f986639d0 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -33,9 +33,8 @@ Pillow is the friendly PIL fork by `Alex Clark and Contributors Date: Wed, 30 Sep 2015 08:30:40 -0400 Subject: [PATCH 10/14] Wording --- docs/developer/index.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/developer/index.rst b/docs/developer/index.rst index 19f823ee6..c7a4d9838 100644 --- a/docs/developer/index.rst +++ b/docs/developer/index.rst @@ -16,10 +16,10 @@ The version number is currently stored in 3 places:: PIL/__init__.py _imaging.c setup.py -Readthedocs -~~~~~~~~~~~ +Read the Docs +~~~~~~~~~~~~~ -Make sure the default version for Readthedocs is the latest release version e.g. 3.0.0 not latest. +Make sure the default version for Read the Docs is the latest release version e.g. 3.0.0 not latest. Release notes ------------- From cfd87ccad2690dcb1cf06e250ddcd1b702acc85b Mon Sep 17 00:00:00 2001 From: Alex Clark Date: Wed, 30 Sep 2015 08:37:02 -0400 Subject: [PATCH 11/14] Move CI note to contributing --- CONTRIBUTING.md | 1 + docs/developer/index.rst | 30 ------------------------------ 2 files changed, 1 insertion(+), 30 deletions(-) delete mode 100644 docs/developer/index.rst diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5a49ab2d7..40dd9119e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -17,6 +17,7 @@ Please send a pull request to the master branch. Please include [documentation]( - Separate code commits from reformatting commits. - Provide tests for any newly added code. - Follow PEP8. +- When committing only trivial changes please include [ci skip] in the commit message to avoid running tests on Travis-CI. ## Reporting Issues diff --git a/docs/developer/index.rst b/docs/developer/index.rst deleted file mode 100644 index c7a4d9838..000000000 --- a/docs/developer/index.rst +++ /dev/null @@ -1,30 +0,0 @@ -Developer -========= - -.. Note:: When committing only trivial changes, please include [ci skip] in the commit message to avoid running tests on Travis-CI. Thank you! - -Release -------- - -Details about making a Pillow release. - -Version number -~~~~~~~~~~~~~~ - -The version number is currently stored in 3 places:: - - PIL/__init__.py _imaging.c setup.py - - -Read the Docs -~~~~~~~~~~~~~ - -Make sure the default version for Read the Docs is the latest release version e.g. 3.0.0 not latest. - -Release notes -------------- - -.. toctree:: - :maxdepth: 2 - - releasenotes/index.rst From 02c00c10b7eb6295b8577632083c3bb7772d2f96 Mon Sep 17 00:00:00 2001 From: Alex Clark Date: Wed, 30 Sep 2015 08:43:21 -0400 Subject: [PATCH 12/14] Add RTD blurb --- RELEASING.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/RELEASING.md b/RELEASING.md index fbfd8f2b4..b3739746b 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -103,3 +103,7 @@ Released as needed privately to individual vendors for critical security-related ## Publicize Release * [ ] Announce release availability via [Twitter](https://twitter.com/pythonpillow) e.g. https://twitter.com/aclark4life/status/583366798302691328. + +## Documentation + +* [ ] Make sure the default version for Read the Docs is the latest release version e.g. 3.0.0 not latest: https://readthedocs.org/dashboard/pillow/versions/ From 8e05ae6fb8cefe29322dee81c9f746532f302a49 Mon Sep 17 00:00:00 2001 From: Alex Clark Date: Wed, 30 Sep 2015 09:10:28 -0400 Subject: [PATCH 13/14] Add doc build & linkcheck to CI --- .travis.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.travis.yml b/.travis.yml index 48b61d32b..368b2ac87 100644 --- a/.travis.yml +++ b/.travis.yml @@ -46,6 +46,8 @@ script: - if [ "$TRAVIS_PYTHON_VERSION" != "nightly" ]; then coverage run --append --include=PIL/* selftest.py; fi - if [ "$TRAVIS_PYTHON_VERSION" != "nightly" ]; then coverage run --append --include=PIL/* -m nose -vx Tests/test_*.py; fi - check-manifest --ignore "depends/*" + # Sphinx + - cd docs; make html; make linkcheck after_success: # gather the coverage data From 93a326dc01d64bbd496101c483d0eb2aac4b45ae Mon Sep 17 00:00:00 2001 From: Alex Clark Date: Wed, 30 Sep 2015 09:37:54 -0400 Subject: [PATCH 14/14] Install Sphinx; pushd/popd instead of cd --- .travis.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.travis.yml b/.travis.yml index 368b2ac87..a2b2d7a56 100644 --- a/.travis.yml +++ b/.travis.yml @@ -23,6 +23,7 @@ install: - "travis_retry pip install cffi" - "travis_retry pip install nose" - "travis_retry pip install check-manifest" + - "travis_retry pip install Sphinx" # Pyroma tests sometimes hang on PyPy and Python 2.6; skip for those - if [ $TRAVIS_PYTHON_VERSION != "pypy" && $TRAVIS_PYTHON_VERSION != "2.6" ]; then travis_retry pip install pyroma; fi @@ -47,7 +48,7 @@ script: - if [ "$TRAVIS_PYTHON_VERSION" != "nightly" ]; then coverage run --append --include=PIL/* -m nose -vx Tests/test_*.py; fi - check-manifest --ignore "depends/*" # Sphinx - - cd docs; make html; make linkcheck + - pushd docs; make html; make linkcheck; popd after_success: # gather the coverage data