mirror of
https://github.com/python-pillow/Pillow.git
synced 2025-01-13 02:36:17 +03:00
Use sphinx-inline-tabs to organise installation per OS
This commit is contained in:
parent
a2570164cc
commit
e3a46fcfd0
|
@ -13,6 +13,10 @@ indent_style = space
|
||||||
|
|
||||||
trim_trailing_whitespace = true
|
trim_trailing_whitespace = true
|
||||||
|
|
||||||
|
[*.rst]
|
||||||
|
# Three-space indentation
|
||||||
|
indent_size = 3
|
||||||
|
|
||||||
[*.yml]
|
[*.yml]
|
||||||
# Two-space indentation
|
# Two-space indentation
|
||||||
indent_size = 2
|
indent_size = 2
|
||||||
|
|
|
@ -43,7 +43,7 @@ clean:
|
||||||
-rm -rf $(BUILDDIR)/*
|
-rm -rf $(BUILDDIR)/*
|
||||||
|
|
||||||
install-sphinx:
|
install-sphinx:
|
||||||
$(PYTHON) -m pip install --quiet sphinx sphinx-copybutton sphinx-issues sphinx-removed-in sphinxext-opengraph furo olefile
|
$(PYTHON) -m pip install --quiet furo olefile sphinx sphinx-copybutton sphinx-inline-tabs sphinx-issues sphinx-removed-in sphinxext-opengraph
|
||||||
|
|
||||||
html:
|
html:
|
||||||
$(MAKE) install-sphinx
|
$(MAKE) install-sphinx
|
||||||
|
|
|
@ -27,12 +27,13 @@ needs_sphinx = "2.4"
|
||||||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
||||||
# ones.
|
# ones.
|
||||||
extensions = [
|
extensions = [
|
||||||
"sphinx_copybutton",
|
|
||||||
"sphinx_issues",
|
|
||||||
"sphinx_removed_in",
|
|
||||||
"sphinx.ext.autodoc",
|
"sphinx.ext.autodoc",
|
||||||
"sphinx.ext.intersphinx",
|
"sphinx.ext.intersphinx",
|
||||||
"sphinx.ext.viewcode",
|
"sphinx.ext.viewcode",
|
||||||
|
"sphinx_copybutton",
|
||||||
|
"sphinx_inline_tabs",
|
||||||
|
"sphinx_issues",
|
||||||
|
"sphinx_removed_in",
|
||||||
"sphinxext.opengraph",
|
"sphinxext.opengraph",
|
||||||
]
|
]
|
||||||
|
|
||||||
|
|
|
@ -23,6 +23,11 @@ Pillow supports these Python versions.
|
||||||
:file: older-versions.csv
|
:file: older-versions.csv
|
||||||
:header-rows: 1
|
:header-rows: 1
|
||||||
|
|
||||||
|
.. _Windows Installation:
|
||||||
|
.. _macOS Installation:
|
||||||
|
.. _Linux Installation:
|
||||||
|
.. _FreeBSD Installation:
|
||||||
|
|
||||||
Basic Installation
|
Basic Installation
|
||||||
------------------
|
------------------
|
||||||
|
|
||||||
|
@ -38,8 +43,7 @@ Install Pillow with :command:`pip`::
|
||||||
python3 -m pip install --upgrade Pillow
|
python3 -m pip install --upgrade Pillow
|
||||||
|
|
||||||
|
|
||||||
Windows Installation
|
.. tab:: Windows
|
||||||
^^^^^^^^^^^^^^^^^^^^
|
|
||||||
|
|
||||||
We provide Pillow binaries for Windows compiled for the matrix of
|
We provide Pillow binaries for Windows compiled for the matrix of
|
||||||
supported Pythons in both 32 and 64-bit versions in the wheel format.
|
supported Pythons in both 32 and 64-bit versions in the wheel format.
|
||||||
|
@ -52,9 +56,7 @@ FriBiDi to be installed separately::
|
||||||
|
|
||||||
To install Pillow in MSYS2, see `Building on Windows using MSYS2/MinGW`_.
|
To install Pillow in MSYS2, see `Building on Windows using MSYS2/MinGW`_.
|
||||||
|
|
||||||
|
.. tab:: macOS
|
||||||
macOS Installation
|
|
||||||
^^^^^^^^^^^^^^^^^^
|
|
||||||
|
|
||||||
We provide binaries for macOS for each of the supported Python
|
We provide binaries for macOS for each of the supported Python
|
||||||
versions in the wheel format. These include support for all optional
|
versions in the wheel format. These include support for all optional
|
||||||
|
@ -64,8 +66,7 @@ FriBiDi to be installed separately::
|
||||||
python3 -m pip install --upgrade pip
|
python3 -m pip install --upgrade pip
|
||||||
python3 -m pip install --upgrade Pillow
|
python3 -m pip install --upgrade Pillow
|
||||||
|
|
||||||
Linux Installation
|
.. tab:: Linux
|
||||||
^^^^^^^^^^^^^^^^^^
|
|
||||||
|
|
||||||
We provide binaries for Linux for each of the supported Python
|
We provide binaries for Linux for each of the supported Python
|
||||||
versions in the manylinux wheel format. These include support for all
|
versions in the manylinux wheel format. These include support for all
|
||||||
|
@ -80,8 +81,7 @@ also include Pillow in packages that previously contained PIL e.g.
|
||||||
``python-imaging``. Debian splits it into two packages, ``python3-pil``
|
``python-imaging``. Debian splits it into two packages, ``python3-pil``
|
||||||
and ``python3-pil.imagetk``.
|
and ``python3-pil.imagetk``.
|
||||||
|
|
||||||
FreeBSD Installation
|
.. tab:: FreeBSD
|
||||||
^^^^^^^^^^^^^^^^^^^^
|
|
||||||
|
|
||||||
Pillow can be installed on FreeBSD via the official Ports or Packages systems:
|
Pillow can be installed on FreeBSD via the official Ports or Packages systems:
|
||||||
|
|
||||||
|
@ -100,6 +100,13 @@ Pillow can be installed on FreeBSD via the official Ports or Packages systems:
|
||||||
are tested by the ports team with all supported FreeBSD versions.
|
are tested by the ports team with all supported FreeBSD versions.
|
||||||
|
|
||||||
|
|
||||||
|
.. _Building on macOS:
|
||||||
|
.. _Building on Windows:
|
||||||
|
.. _Building on Windows using MSYS2/MinGW:
|
||||||
|
.. _Building on FreeBSD:
|
||||||
|
.. _Building on Linux:
|
||||||
|
.. _Building on Android:
|
||||||
|
|
||||||
Building From Source
|
Building From Source
|
||||||
--------------------
|
--------------------
|
||||||
|
|
||||||
|
@ -187,8 +194,7 @@ Many of Pillow's features require external libraries:
|
||||||
|
|
||||||
* **libxcb** provides X11 screengrab support.
|
* **libxcb** provides X11 screengrab support.
|
||||||
|
|
||||||
Building on macOS
|
.. tab:: macOS
|
||||||
"""""""""""""""""
|
|
||||||
|
|
||||||
The Xcode command line tools are required to compile portions of
|
The Xcode command line tools are required to compile portions of
|
||||||
Pillow. The tools are installed by running ``xcode-select --install``
|
Pillow. The tools are installed by running ``xcode-select --install``
|
||||||
|
@ -208,8 +214,7 @@ To install libraqm on macOS use Homebrew to install its dependencies::
|
||||||
|
|
||||||
Then see ``depends/install_raqm_cmake.sh`` to install libraqm.
|
Then see ``depends/install_raqm_cmake.sh`` to install libraqm.
|
||||||
|
|
||||||
Building on Windows
|
.. tab:: Windows
|
||||||
"""""""""""""""""""
|
|
||||||
|
|
||||||
We recommend you use prebuilt wheels from PyPI.
|
We recommend you use prebuilt wheels from PyPI.
|
||||||
If you wish to compile Pillow manually, you can use the build scripts
|
If you wish to compile Pillow manually, you can use the build scripts
|
||||||
|
@ -219,8 +224,7 @@ These scripts require Visual Studio 2017 or newer and NASM.
|
||||||
The scripts also install Pillow from the local copy of the source code, so the
|
The scripts also install Pillow from the local copy of the source code, so the
|
||||||
`Installing`_ instructions will not be necessary afterwards.
|
`Installing`_ instructions will not be necessary afterwards.
|
||||||
|
|
||||||
Building on Windows using MSYS2/MinGW
|
.. tab:: Windows using MSYS2/MinGW
|
||||||
"""""""""""""""""""""""""""""""""""""
|
|
||||||
|
|
||||||
To build Pillow using MSYS2, make sure you run the **MSYS2 MinGW 32-bit** or
|
To build Pillow using MSYS2, make sure you run the **MSYS2 MinGW 32-bit** or
|
||||||
**MSYS2 MinGW 64-bit** console, *not* **MSYS2** directly.
|
**MSYS2 MinGW 64-bit** console, *not* **MSYS2** directly.
|
||||||
|
@ -249,8 +253,7 @@ Prerequisites are installed on **MSYS2 MinGW 64-bit** with::
|
||||||
mingw-w64-x86_64-libimagequant \
|
mingw-w64-x86_64-libimagequant \
|
||||||
mingw-w64-x86_64-libraqm
|
mingw-w64-x86_64-libraqm
|
||||||
|
|
||||||
Building on FreeBSD
|
.. tab:: FreeBSD
|
||||||
"""""""""""""""""""
|
|
||||||
|
|
||||||
.. Note:: Only FreeBSD 10 and 11 tested
|
.. Note:: Only FreeBSD 10 and 11 tested
|
||||||
|
|
||||||
|
@ -264,8 +267,7 @@ Prerequisites are installed on **FreeBSD 10 or 11** with::
|
||||||
|
|
||||||
Then see ``depends/install_raqm_cmake.sh`` to install libraqm.
|
Then see ``depends/install_raqm_cmake.sh`` to install libraqm.
|
||||||
|
|
||||||
Building on Linux
|
.. tab:: Linux
|
||||||
"""""""""""""""""
|
|
||||||
|
|
||||||
If you didn't build Python from source, make sure you have Python's
|
If you didn't build Python from source, make sure you have Python's
|
||||||
development libraries installed.
|
development libraries installed.
|
||||||
|
@ -312,8 +314,7 @@ See also the ``Dockerfile``\s in the Test Infrastructure repo
|
||||||
(https://github.com/python-pillow/docker-images) for a known working
|
(https://github.com/python-pillow/docker-images) for a known working
|
||||||
install process for other tested distros.
|
install process for other tested distros.
|
||||||
|
|
||||||
Building on Android
|
.. tab:: Android
|
||||||
"""""""""""""""""""
|
|
||||||
|
|
||||||
Basic Android support has been added for compilation within the Termux
|
Basic Android support has been added for compilation within the Termux
|
||||||
environment. The dependencies can be installed by::
|
environment. The dependencies can be installed by::
|
||||||
|
|
Loading…
Reference in New Issue
Block a user