Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update installation docs #7858

Merged
merged 7 commits into from
Mar 7, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions docs/installation/basic-installation.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,15 @@
.. raw:: html

<script>
document.addEventListener('DOMContentLoaded', function() {
activateTab(getOS());
});
</script>

.. _basic-installation:

Basic Installation
------------------
==================

.. note::

Expand Down Expand Up @@ -68,7 +76,7 @@ and :pypi:`olefile` for Pillow to read FPX and MIC images::
python3 -m pip install --upgrade pip
python3 -m pip install --upgrade Pillow

To install Pillow in MSYS2, see `Building on Windows using MSYS2/MinGW`_.
To install Pillow in MSYS2, see :ref:`building-from-source`.

.. tab:: FreeBSD

Expand All @@ -87,11 +95,3 @@ and :pypi:`olefile` for Pillow to read FPX and MIC images::
The `Pillow FreeBSD port
<https://www.freshports.org/graphics/py-pillow/>`_ and packages
are tested by the ports team with all supported FreeBSD versions.


.. _Building on Linux:
.. _Building on macOS:
.. _Building on Windows:
.. _Building on Windows using MSYS2/MinGW:
.. _Building on FreeBSD:
.. _Building on Android:
25 changes: 21 additions & 4 deletions docs/installation/building-from-source.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,20 @@
.. raw:: html

<script>
document.addEventListener('DOMContentLoaded', function() {
activateTab(getOS());
});
</script>

.. _building-from-source:

Building From Source
--------------------
====================

.. _external-libraries:

External Libraries
^^^^^^^^^^^^^^^^^^
------------------

.. note::

Expand Down Expand Up @@ -221,7 +229,7 @@ Many of Pillow's features require external libraries:
This has been tested within the Termux app on ChromeOS, on x86.

Installing
^^^^^^^^^^
----------

Once you have installed the prerequisites, to install Pillow from the source
code on PyPI, run::
Expand Down Expand Up @@ -256,7 +264,7 @@ After navigating to the Pillow directory, run::
.. _compressed archive from PyPI: https://pypi.org/project/pillow/#files

Build Options
"""""""""""""
^^^^^^^^^^^^^

* Environment variable: ``MAX_CONCURRENCY=n``. Pillow can use
multiprocessing to build the extension. Setting ``MAX_CONCURRENCY``
Expand Down Expand Up @@ -298,3 +306,12 @@ Build Options
Sample usage::

python3 -m pip install --upgrade Pillow -C [feature]=enable

.. _old-versions:

Old Versions
============

You can download old distributions from the `release history at PyPI
<https://pypi.org/project/pillow/#history>`_ and by direct URL access
eg. https://pypi.org/project/pillow/1.0/.
1 change: 0 additions & 1 deletion docs/installation/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,3 @@ Installation
python-support
platform-support
building-from-source
old-versions
8 changes: 0 additions & 8 deletions docs/installation/old-versions.rst

This file was deleted.

6 changes: 3 additions & 3 deletions docs/installation/platform-support.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _platform-support:

Platform Support
----------------
================

Current platform support for Pillow. Binary distributions are
contributed for each release on a volunteer basis, but the source
Expand All @@ -10,7 +10,7 @@ general, we aim to support all current versions of Linux, macOS, and
Windows.

Continuous Integration Targets
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
------------------------------

These platforms are built and tested for every change.

Expand Down Expand Up @@ -66,7 +66,7 @@ These platforms are built and tested for every change.


Other Platforms
^^^^^^^^^^^^^^^
---------------

These platforms have been reported to work at the versions mentioned.

Expand Down
7 changes: 1 addition & 6 deletions docs/installation/python-support.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _python-support:

Python Support
--------------
==============

Pillow supports these Python versions.

Expand All @@ -12,8 +12,3 @@ Pillow supports these Python versions.
.. csv-table:: Older versions
:file: older-versions.csv
:header-rows: 1

.. _Linux Installation:
.. _macOS Installation:
.. _Windows Installation:
.. _FreeBSD Installation: