Skip to content

Commit 0e36819

Browse files
authored
Address docs build failure on readthedocs (#568)
Signed-off-by: M Q <[email protected]>
1 parent f17c518 commit 0e36819

File tree

2 files changed

+9
-14
lines changed

2 files changed

+9
-14
lines changed

docs/requirements.txt

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
1-
Sphinx>=4.5.0
1+
Sphinx>=5.3.0,<8.0.0
22
sphinx-autobuild
33
myst-nb>=0.17.2
44
myst-parser>=0.18.0
5-
lxml_html_clean # needed by myst-nb
6-
linkify-it-py>=1.0.1 # https://myst-parser.readthedocs.io/en/latest/syntax/optional.html?highlight=linkify#linkify
5+
lxml_html_clean
6+
linkify-it-py>=1.0.1
77
sphinx-togglebutton
88
sphinx-copybutton
9-
sphinxcontrib-bibtex>=2.4.1 # Version 2.4.1+ supports Python 3.10
10-
sphinxcontrib-spelling # https://sphinxcontrib-spelling.readthedocs.io/en/latest/index.html
11-
sphinx-thebe
9+
sphinxcontrib-bibtex>=2.4.1
10+
sphinxcontrib-spelling
11+
sphinx-thebe>=0.3.0
1212
sphinx-design
1313
ablog
1414
pydata_sphinx_theme>=0.13.0
1515
sphinxemoji
1616
torch>=1.12.0
17-
sphinx-autodoc-typehints
17+
sphinx-autodoc-typehints>=1.19.0
1818
sphinxcontrib-applehelp
1919
sphinxcontrib-devhelp
2020
sphinxcontrib-htmlhelp

docs/source/conf.py

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -225,15 +225,10 @@
225225
# (reference: https://myst-nb.readthedocs.io/en/latest/)
226226
# Prevent creating jupyter_execute folder in dist
227227
# https://myst-nb.readthedocs.io/en/latest/use/execute.html#executing-in-temporary-folders # noqa
228-
execution_in_temp = True
229-
jupyter_execute_notebooks = "off"
228+
nb_execution_in_temp = True
229+
nb_execution_mode = "off"
230230

231231

232-
# -- Options for sphinxcontrib.bibtex -------------------------------------------------
233-
#
234-
# (reference: https://sphinxcontrib-bibtex.readthedocs.io/)
235-
bibtex_bibfiles = [] # Add bibliography files here if needed
236-
237232
# -- Options for sphinxcontrib.spelling -------------------------------------------------
238233
#
239234
# (reference: https://sphinxcontrib-spelling.readthedocs.io/en/latest/customize.html)

0 commit comments

Comments
 (0)