Skip to content

Commit 4f93dd8

Browse files
authored
Docs: Fix build 3 warnings (readthedocs#9809)
* Run local Sphinx builds that look more like the ones on Read the Docs ('-j auto' for parallel builds + fail on Warnings) * Bump sphinxcontrib-httpdomain==1.8.1 and readthedocs-sphinx-search==0.1.2
1 parent f86b537 commit 4f93dd8

File tree

3 files changed

+17
-8
lines changed

3 files changed

+17
-8
lines changed

docs/Makefile

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,12 @@
22
#
33

44
# You can set these variables from the command line.
5-
SPHINXOPTS =
5+
6+
# Options should be aligned with how the documentation is built on RTD
7+
# (except for '--keep-going', failing fast is prefered on local builds)
8+
# We also remove '-E' to reduce the time of rebuilding reference indexes
9+
# on each build.
10+
SPHINXOPTS = -T -j auto -W
611
SPHINXBUILD = sphinx-build
712
PAPER =
813
PROJECT ?= user

requirements/docs.in

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,22 @@
33
-r pip.txt
44

55
sphinx_rtd_theme==1.1.0
6+
# Note: Version 3.4.1 of sphinx-tabs requires docutils 0.18 which is yet to be supported by sphinx-rtd-theme
7+
# Version 3.4.0 has an incompatible Jinja2 version which also blocks sphinx-rtd-theme
8+
# All-together, we cannot upgrade to Sphinx 5.x before either sphinx-tabs or sphinx-rtd-theme fixes these
9+
# issues.
610
sphinx-tabs==3.3.1
711
sphinx-intl==2.0.1
812
sphinx-design==0.2.0
913
sphinx-multiproject==1.0.0rc1
10-
readthedocs-sphinx-search==0.1.1
14+
readthedocs-sphinx-search==0.1.2
1115

1216
# Test out hoverxref
1317
git+https://github.com/readthedocs/sphinx-hoverxref
1418

1519
# Docs
1620
sphinxemoji==0.2.0
17-
sphinxcontrib-httpdomain==1.8.0
21+
sphinxcontrib-httpdomain==1.8.1
1822
sphinx-prompt==1.4.0
1923
sphinx-notfound-page==0.8
2024
sphinx-autobuild==2021.3.14

requirements/docs.txt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
#
2-
# This file is autogenerated by pip-compile with Python 3.10
3-
# by the following command:
2+
# This file is autogenerated by pip-compile with python 3.10
3+
# To update, run:
44
#
5-
# pip-compile --output-file=requirements/docs.txt requirements/docs.in
5+
# pip-compile requirements/docs.in
66
#
77
alabaster==0.7.12
88
# via
@@ -305,7 +305,7 @@ pyyaml==5.4.1
305305
# via
306306
# -r requirements/pip.txt
307307
# myst-parser
308-
readthedocs-sphinx-search==0.1.1
308+
readthedocs-sphinx-search==0.1.2
309309
# via -r requirements/docs.in
310310
redis==3.5.3
311311
# via -r requirements/pip.txt
@@ -397,7 +397,7 @@ sphinxcontrib-htmlhelp==2.0.0
397397
# via
398398
# -r requirements/pip.txt
399399
# sphinx
400-
sphinxcontrib-httpdomain==1.8.0
400+
sphinxcontrib-httpdomain==1.8.1
401401
# via -r requirements/docs.in
402402
sphinxcontrib-jquery==3.0.0
403403
# via sphinx-hoverxref

0 commit comments

Comments
 (0)