Skip to content

Docs: Fix build 3 warnings #9809

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Dec 14, 2022
Merged

Docs: Fix build 3 warnings #9809

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b5dd3f5
Run local Sphinx builds that look more like the ones on Read the Docs…
benjaoming Dec 14, 2022
10c8bbe
Bump sphinxcontrib-httpdomain==1.8.1 and readthedocs-sphinx-search==0…
benjaoming Dec 14, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion docs/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,12 @@
#

# You can set these variables from the command line.
SPHINXOPTS =

# Options should be aligned with how the documentation is built on RTD
# (except for '--keep-going', failing fast is prefered on local builds)
# We also remove '-E' to reduce the time of rebuilding reference indexes
# on each build.
SPHINXOPTS = -T -j auto -W
SPHINXBUILD = sphinx-build
PAPER =
PROJECT ?= user
Expand Down
8 changes: 6 additions & 2 deletions requirements/docs.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,22 @@
-r pip.txt

sphinx_rtd_theme==1.1.0
# Note: Version 3.4.1 of sphinx-tabs requires docutils 0.18 which is yet to be supported by sphinx-rtd-theme
# Version 3.4.0 has an incompatible Jinja2 version which also blocks sphinx-rtd-theme
# All-together, we cannot upgrade to Sphinx 5.x before either sphinx-tabs or sphinx-rtd-theme fixes these
# issues.
sphinx-tabs==3.3.1
Comment on lines +8 to 10
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can probably migrate sphinx-tabs to sphinx-design: https://sphinx-design.readthedocs.io/en/latest/tabs.html at some point

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That would be really great. 1) to have one extension less and 2) I got an impression that sphinx-tabs is less maintained nowadays.

sphinx-intl==2.0.1
sphinx-design==0.2.0
sphinx-multiproject==1.0.0rc1
readthedocs-sphinx-search==0.1.1
readthedocs-sphinx-search==0.1.2

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

# Docs
sphinxemoji==0.2.0
sphinxcontrib-httpdomain==1.8.0
sphinxcontrib-httpdomain==1.8.1
sphinx-prompt==1.4.0
sphinx-notfound-page==0.8
sphinx-autobuild==2021.3.14
Expand Down
10 changes: 5 additions & 5 deletions requirements/docs.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
#
# This file is autogenerated by pip-compile with Python 3.10
# by the following command:
# This file is autogenerated by pip-compile with python 3.10
# To update, run:
#
# pip-compile --output-file=requirements/docs.txt requirements/docs.in
# pip-compile requirements/docs.in
#
alabaster==0.7.12
# via
Expand Down Expand Up @@ -305,7 +305,7 @@ pyyaml==5.4.1
# via
# -r requirements/pip.txt
# myst-parser
readthedocs-sphinx-search==0.1.1
readthedocs-sphinx-search==0.1.2
# via -r requirements/docs.in
redis==3.5.3
# via -r requirements/pip.txt
Expand Down Expand Up @@ -397,7 +397,7 @@ sphinxcontrib-htmlhelp==2.0.0
# via
# -r requirements/pip.txt
# sphinx
sphinxcontrib-httpdomain==1.8.0
sphinxcontrib-httpdomain==1.8.1
# via -r requirements/docs.in
sphinxcontrib-jquery==3.0.0
# via sphinx-hoverxref
Expand Down