python-pillow/Pillow
1
1
Fork 0
mirror of https://github.com/python-pillow/Pillow.git synced 2025-02-25 16:20:33 +03:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #5498 from hugovk/improve-docs

Browse Source 
Build docs with sphinx_copybutton and sphinxext.opengraph
This commit is contained in:
Andrew Murray 2021-05-17 22:25:25 +10:00 committed by GitHub
commit ae0efcb051
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 16 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -103,7 +103,7 @@ jobs:
- name: Docs - name: Docs
if: startsWith(matrix.os, 'ubuntu') && matrix.python-version == 3.9 if: startsWith(matrix.os, 'ubuntu') && matrix.python-version == 3.9
run: | 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 make doccheck
- name: After success - name: After success

13
docs/conf.py
View File

@ -29,11 +29,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_issues", "sphinxext.opengraph",
"sphinx_removed_in",
] ]
intersphinx_mapping = {"python": ("https://docs.python.org/3", None)} intersphinx_mapping = {"python": ("https://docs.python.org/3", None)}
@ -316,3 +318,10 @@ def setup(app):
# GitHub repo for sphinx-issues # GitHub repo for sphinx-issues
issues_github_path = "python-pillow/Pillow" 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"
)
ogp_image_alt = "Pillow"

4
docs/installation.rst
View File

@ -6,9 +6,9 @@ Warnings
.. warning:: Pillow and PIL cannot co-exist in the same environment. Before installing Pillow, please uninstall PIL. .. 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 Python Support
-------------- --------------

2
requirements.txt
View File

@ -10,6 +10,8 @@ pytest
pytest-cov pytest-cov
pytest-timeout pytest-timeout
sphinx>=2.4 sphinx>=2.4
sphinx-copybutton
sphinx-issues sphinx-issues
sphinx-removed-in sphinx-removed-in
sphinx-rtd-theme sphinx-rtd-theme
sphinxext-opengraph