Merge pull request #10352 from AA-Turner/sphinx-docs-build

Don't use deprecated `setup.py build_sphinx`
sphinx-doc · Apr 17, 2022 · eff6930 · eff6930
2 parents 39311e9 + 26e00bd
commit eff6930
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 6 deletions.
diff --git a/doc/conf.py b/doc/conf.py
@@ -148,9 +148,9 @@ def linkify_issues_in_changelog(app, docname, source):
         # this path trickery is needed because this script can
         # be invoked with different working directories:
         # * running make in docs/
-        # * running python setup.py build_sphinx in the repo root dir
+        # * running tox -e docs in the repo root dir
 
-        with open(changelog_path) as f:
+        with open(changelog_path, encoding="utf-8") as f:
             changelog = f.read()
 
         def linkify(match):

diff --git a/setup.cfg b/setup.cfg
@@ -9,9 +9,6 @@ tag_date = true
 release = egg_info -Db ''
 upload = upload --sign --identity=36580288
 
-[build_sphinx]
-warning-is-error = 1
-
 [flake8]
 max-line-length = 95
 ignore = E116,E241,E251,E741,W504,I101

diff --git a/tox.ini b/tox.ini
@@ -83,7 +83,7 @@ description =
 extras =
     docs
 commands =
-    python setup.py build_sphinx {posargs}
+    python -m sphinx -M html ./doc ./build/sphinx -W
 
 [testenv:docslint]
 basepython = python3