diff --git a/.travis.yml b/.travis.yml index 48b61d32b..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 @@ -46,6 +47,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 + - pushd docs; make html; make linkcheck; popd after_success: # gather the coverage data 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/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/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/ 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/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/developer.rst b/docs/developer.rst deleted file mode 100644 index ea3b0f05e..000000000 --- a/docs/developer.rst +++ /dev/null @@ -1,17 +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 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 85% rename from docs/releasenotes/index.rst rename to docs/developer/releasenotes/index.rst index d70edc54d..39814d23f 100644 --- a/docs/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:: 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 5b0a5d4af..f986639d0 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -30,13 +30,13 @@ Pillow is the friendly PIL fork by `Alex Clark and Contributors