From 5caa04c2d1ea298774ef341f7e4cde9c753c8ded Mon Sep 17 00:00:00 2001 From: Hugo van Kemenade Date: Tue, 11 May 2021 19:07:21 +0300 Subject: [PATCH 1/5] Build docs with sphinx_copybutton and sphinxext.opengraph --- .github/workflows/test.yml | 2 +- docs/conf.py | 6 ++++-- requirements.txt | 2 ++ 3 files changed, 7 insertions(+), 3 deletions(-) diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index e52fefc69..cf7bcb6b9 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -103,7 +103,7 @@ jobs: - name: Docs if: startsWith(matrix.os, 'ubuntu') && matrix.python-version == 3.9 run: | - python3 -m pip install sphinx-issues sphinx-removed-in sphinx-rtd-theme + python3 -m pip install sphinx_copybutton sphinx-issues sphinx-removed-in sphinx-rtd-theme sphinxext-opengraph make doccheck - name: After success diff --git a/docs/conf.py b/docs/conf.py index 123e93c9b..6d2f3df06 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -29,11 +29,13 @@ needs_sphinx = "2.4" # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ + "sphinx_copybutton", + "sphinx_issues", + "sphinx_removed_in", "sphinx.ext.autodoc", "sphinx.ext.intersphinx", "sphinx.ext.viewcode", - "sphinx_issues", - "sphinx_removed_in", + "sphinxext.opengraph", ] intersphinx_mapping = {"python": ("https://docs.python.org/3", None)} diff --git a/requirements.txt b/requirements.txt index 4b534ae53..fd2ede5fd 100644 --- a/requirements.txt +++ b/requirements.txt @@ -10,6 +10,8 @@ pytest pytest-cov pytest-timeout sphinx>=2.4 +sphinx-copybutton sphinx-issues sphinx-removed-in sphinx-rtd-theme +sphinxext-opengraph From 7f9037a8cabfad45160a40ba4e4d44f3b730dd4b Mon Sep 17 00:00:00 2001 From: Hugo van Kemenade Date: Wed, 12 May 2021 00:01:51 +0300 Subject: [PATCH 2/5] Use code formatting --- docs/installation.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/installation.rst b/docs/installation.rst index 6ce00eefd..b1ef58509 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -6,9 +6,9 @@ Warnings .. warning:: Pillow and PIL cannot co-exist in the same environment. Before installing Pillow, please uninstall PIL. -.. warning:: Pillow >= 1.0 no longer supports "import Image". Please use "from PIL import Image" instead. +.. warning:: Pillow >= 1.0 no longer supports ``import Image``. Please use ``from PIL import Image`` instead. -.. warning:: Pillow >= 2.1.0 no longer supports "import _imaging". Please use "from PIL.Image import core as _imaging" instead. +.. warning:: Pillow >= 2.1.0 no longer supports ``import _imaging``. Please use ``from PIL.Image import core as _imaging`` instead. Python Support -------------- From d49000beaa9374befc0f40973dced355cd870c23 Mon Sep 17 00:00:00 2001 From: Hugo van Kemenade Date: Fri, 14 May 2021 21:30:39 +0300 Subject: [PATCH 3/5] Add og:image --- docs/conf.py | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/conf.py b/docs/conf.py index 6d2f3df06..88e1fcabf 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -318,3 +318,9 @@ def setup(app): # GitHub repo for sphinx-issues issues_github_path = "python-pillow/Pillow" + +# sphinxext.opengraph +ogp_image = ( + "https://raw.githubusercontent.com/python-pillow/pillow-logo/master/" + "pillow-logo-dark-text-1280x640.png" +) From 23467636ad91656da1da17e692f832de558483f3 Mon Sep 17 00:00:00 2001 From: Andrew Murray Date: Sat, 15 May 2021 09:07:36 +1000 Subject: [PATCH 4/5] Set og:image:alt to be constant --- docs/conf.py | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/conf.py b/docs/conf.py index 88e1fcabf..9b4eb669b 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -324,3 +324,4 @@ ogp_image = ( "https://raw.githubusercontent.com/python-pillow/pillow-logo/master/" "pillow-logo-dark-text-1280x640.png" ) +ogp_image_alt = "Pillow" From ca97b16c0ac9dc9efe5fd08f941e36f4b87bad0f Mon Sep 17 00:00:00 2001 From: Hugo van Kemenade Date: Sun, 16 May 2021 09:46:00 +0300 Subject: [PATCH 5/5] Install normalised sphinx-copybutton Co-authored-by: Andrew Murray <3112309+radarhere@users.noreply.github.com> --- .github/workflows/test.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index cf7bcb6b9..f2953072a 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -103,7 +103,7 @@ jobs: - name: Docs if: startsWith(matrix.os, 'ubuntu') && matrix.python-version == 3.9 run: | - python3 -m pip install sphinx_copybutton sphinx-issues sphinx-removed-in sphinx-rtd-theme sphinxext-opengraph + python3 -m pip install sphinx-copybutton sphinx-issues sphinx-removed-in sphinx-rtd-theme sphinxext-opengraph make doccheck - name: After success