Xqt has submitted this change. (
https://gerrit.wikimedia.org/r/c/pywikibot/core/+/1060859?usp=email )
Change subject: [doc] Use Python 3.12 to create documentation
......................................................................
[doc] Use Python 3.12 to create documentation
- run rstcheck, sphinx tests and sphinx doc creation with Python 3.12
- use tomllib library shipped with Pythin 3.11+ instead of tomli package
- update sphinx requirements
Change-Id: Ic58ad749adf05da1af6495ff8d3d82b6ec55f643
---
M docs/conf.py
M docs/requirements.txt
M tox.ini
3 files changed, 10 insertions(+), 12 deletions(-)
Approvals:
Xqt: Looks good to me, approved
jenkins-bot: Verified
diff --git a/docs/conf.py b/docs/conf.py
index e5b0360..94e14b7 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -24,11 +24,10 @@
import os
import re
import sys
+import tomllib
import warnings
from pathlib import Path
-import tomli
-
# Deprecated classes will generate warnings as Sphinx processes them.
# Ignoring them.
@@ -46,7 +45,7 @@
# If your documentation needs a minimal Sphinx version, state it here.
#
-needs_sphinx = '7.3.7'
+needs_sphinx = '8.0.2'
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
@@ -83,7 +82,7 @@
# General information about the project.
filepath = Path().absolute().parent / 'pyproject.toml'
with open(filepath, 'rb') as f:
- meta_data = tomli.load(f)
+ meta_data = tomllib.load(f)
project = meta_data['project']['name'].title()
project_copyright = pywikibot.__copyright__ # alias since Python 3.5
diff --git a/docs/requirements.txt b/docs/requirements.txt
index 32bfea7..34d02d8 100644
--- a/docs/requirements.txt
+++ b/docs/requirements.txt
@@ -1,10 +1,9 @@
# This is a PIP requirements file for building Sphinx documentation of
Pywikibot
# ../requirements.txt is also needed.
# Note: Python 3.9 is required for sphinx 7.2
-sphinx >= 7.3.7
-rstcheck >=6.2.1
+sphinx >= 8.0.2
+rstcheck >=6.2.4
sphinxext-opengraph >= 0.9.1
sphinx-copybutton >= 0.5.2
-sphinx-notfound-page >= 1.0.0
-furo >= 2024.4.27
-tomli
+sphinx-notfound-page >= 1.0.4
+furo >= 2024.8.6
diff --git a/tox.ini b/tox.ini
index 6ac5f90..69b30df 100644
--- a/tox.ini
+++ b/tox.ini
@@ -93,7 +93,7 @@
commands = {posargs}
[testenv:doc]
-basepython = python3.9
+basepython = python3.12
commands =
sphinx-build -M html ./docs ./docs/_build -j auto
deps =
@@ -101,7 +101,7 @@
-rdocs/requirements.txt
[testenv:rstcheck]
-basepython = python3.9
+basepython = python3.12
commands =
rstcheck --version
rstcheck -r --report-level WARNING --ignore-roles api,phab,source .
@@ -110,7 +110,7 @@
-rdocs/requirements.txt
[testenv:sphinx]
-basepython = python3.9
+basepython = python3.12
commands =
sphinx-build -M html ./docs ./docs/_build -j auto -D html_theme=nature
deps =
--
To view, visit
https://gerrit.wikimedia.org/r/c/pywikibot/core/+/1060859?usp=email
To unsubscribe, or for help writing mail filters, visit
https://gerrit.wikimedia.org/r/settings?usp=email
Gerrit-MessageType: merged
Gerrit-Project: pywikibot/core
Gerrit-Branch: master
Gerrit-Change-Id: Ic58ad749adf05da1af6495ff8d3d82b6ec55f643
Gerrit-Change-Number: 1060859
Gerrit-PatchSet: 1
Gerrit-Owner: Xqt <[email protected]>
Gerrit-Reviewer: Xqt <[email protected]>
Gerrit-Reviewer: jenkins-bot
_______________________________________________
Pywikibot-commits mailing list -- [email protected]
To unsubscribe send an email to [email protected]
