python-pillow/Pillow
1
1
Fork 0
mirror of https://github.com/python-pillow/Pillow.git synced 2025-05-03 23:43:40 +03:00
Code Issues Packages Projects Releases Wiki Activity

Build docs with sphinx_copybutton and sphinxext.opengraph

Browse Source
This commit is contained in:
Hugo van Kemenade 2021-05-11 19:07:21 +03:00
parent d74cf22758
commit 5caa04c2d1
3 changed files with 7 additions and 3 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

6
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)}

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