python-pillow/Pillow
1
1
Fork 0
mirror of https://github.com/python-pillow/Pillow.git synced 2025-07-15 02:32:29 +03:00
Code Issues Packages Projects Releases Wiki Activity

Use sphinx_removed_in extension for the '.. versionremoved::' directive

Browse Source
This commit is contained in:
Hugo van Kemenade 2020-07-09 12:24:23 +03:00
parent 4aeb370b69
commit 4323d975be
4 changed files with 16 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.github/workflows/test.yml vendored
View File

@ -98,7 +98,7 @@ jobs:
- name: Docs - name: Docs
if: startsWith(matrix.os, 'ubuntu') && matrix.python-version == 3.8 if: startsWith(matrix.os, 'ubuntu') && matrix.python-version == 3.8
run: | run: |
pip install sphinx-rtd-theme pip install sphinx-removed-in sphinx-rtd-theme
make doccheck make doccheck
- name: After success - name: After success

7
docs/conf.py
View File

@ -27,7 +27,12 @@ needs_sphinx = "2.4"
# Add any Sphinx extension module names here, as strings. They can be # Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones. # ones.
extensions = ["sphinx.ext.autodoc", "sphinx.ext.viewcode", "sphinx.ext.intersphinx"] extensions = [
"sphinx.ext.autodoc",
"sphinx.ext.intersphinx",
"sphinx.ext.viewcode",
"sphinx_removed_in",
]
# The suffix(es) of source filenames. # The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string: # You can specify multiple suffix as a list of string:

16
docs/deprecations.rst
View File

@ -78,7 +78,7 @@ period of deprecation has passed.
Python 2.7 Python 2.7
~~~~~~~~~~ ~~~~~~~~~~
*Removed in version 7.0.0.* .. versionremoved:: 7.0.0
Python 2.7 reached end-of-life on 2020-01-01. Pillow 6.x was the last series to Python 2.7 reached end-of-life on 2020-01-01. Pillow 6.x was the last series to
support Python 2. support Python 2.
@ -86,7 +86,7 @@ support Python 2.
Image.__del__ Image.__del__
~~~~~~~~~~~~~ ~~~~~~~~~~~~~
*Removed in version 7.0.0.* .. versionremoved:: 7.0.0
Implicitly closing the image's underlying file in ``Image.__del__`` has been removed. Implicitly closing the image's underlying file in ``Image.__del__`` has been removed.
Use a context manager or call ``Image.close()`` instead to close the file in a Use a context manager or call ``Image.close()`` instead to close the file in a
@ -109,7 +109,7 @@ Use instead:
PIL.*ImagePlugin.__version__ attributes PIL.*ImagePlugin.__version__ attributes
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*Removed in version 7.0.0.* .. versionremoved:: 7.0.0
The version constants of individual plugins have been removed. Use ``PIL.__version__`` The version constants of individual plugins have been removed. Use ``PIL.__version__``
instead. instead.
@ -134,7 +134,7 @@ Removed Removed Removed
PyQt4 and PySide PyQt4 and PySide
~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~
*Removed in version 7.0.0.* .. versionremoved:: 7.0.0
Qt 4 reached end-of-life on 2015-12-19. Its Python bindings are also EOL: PyQt4 since Qt 4 reached end-of-life on 2015-12-19. Its Python bindings are also EOL: PyQt4 since
2018-08-31 and PySide since 2015-10-14. 2018-08-31 and PySide since 2015-10-14.
@ -145,7 +145,7 @@ or PySide2.
Setting the size of TIFF images Setting the size of TIFF images
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*Removed in version 7.0.0.* .. versionremoved:: 7.0.0
Setting the size of a TIFF image directly (eg. ``im.size = (256, 256)``) throws Setting the size of a TIFF image directly (eg. ``im.size = (256, 256)``) throws
an error. Use ``Image.resize`` instead. an error. Use ``Image.resize`` instead.
@ -153,7 +153,7 @@ an error. Use ``Image.resize`` instead.
VERSION constant VERSION constant
~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~
*Removed in version 6.0.0.* .. versionremoved:: 6.0.0
``VERSION`` (the old PIL version, always 1.1.7) has been removed. Use ``VERSION`` (the old PIL version, always 1.1.7) has been removed. Use
``__version__`` instead. ``__version__`` instead.
@ -161,7 +161,7 @@ VERSION constant
Undocumented ImageOps functions Undocumented ImageOps functions
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*Removed in version 6.0.0.* .. versionremoved:: 6.0.0
Several undocumented functions in ``ImageOps`` have been removed. Use the equivalents Several undocumented functions in ``ImageOps`` have been removed. Use the equivalents
in ``ImageFilter`` instead: in ``ImageFilter`` instead:
@ -179,7 +179,7 @@ Removed Use instead
PIL.OleFileIO PIL.OleFileIO
~~~~~~~~~~~~~ ~~~~~~~~~~~~~
*Removed in version 6.0.0.* .. versionremoved:: 6.0.0
PIL.OleFileIO was removed as a vendored file and in Pillow 4.0.0 (2017-01) in favour of PIL.OleFileIO was removed as a vendored file and in Pillow 4.0.0 (2017-01) in favour of
the upstream olefile Python package, and replaced with an ``ImportError`` in 5.0.0 the upstream olefile Python package, and replaced with an ``ImportError`` in 5.0.0

1
requirements.txt
View File

@ -10,4 +10,5 @@ pyroma
pytest pytest
pytest-cov pytest-cov
sphinx>=2.4 sphinx>=2.4
sphinx-removed-in
sphinx-rtd-theme sphinx-rtd-theme