Docs gen works with Python 3.10+

Signed-off-by: M Q <[email protected]>

Author: MMelQin

docs/requirements.txt

@@ -1,25 +1,24 @@
-Sphinx==4.1.2
-sphinx-autobuild==2021.3.14
-myst-nb==0.17.2  # this version is fine in python 3.9 and avoids pulling in multiple nbformat packages
-myst-parser==0.18.0
+Sphinx>=4.5.0
+sphinx-autobuild
+myst-nb>=0.17.2  # this version is fine in python 3.9 and avoids pulling in multiple nbformat packages
+myst-parser>=0.18.0
 lxml_html_clean  # needed by myst-nb
-linkify-it-py==1.0.1  # https://myst-parser.readthedocs.io/en/latest/syntax/optional.html?highlight=linkify#linkify
-sphinx-togglebutton==0.2.3
-sphinx-copybutton==0.4.0
-sphinxcontrib-bibtex<2.0.0  # https://github.com/executablebooks/jupyter-book/issues/1137
-sphinxcontrib-spelling==7.2.1  # https://sphinxcontrib-spelling.readthedocs.io/en/latest/index.html
-sphinx-thebe==0.0.10
-sphinx-panels==0.6.0
-ablog==0.10.19
-docutils==0.16  # 0.17 causes error. https://github.com/executablebooks/MyST-Parser/issues/343
-pydata_sphinx_theme==0.6.3
-sphinxemoji==0.1.8
+linkify-it-py>=1.0.1  # https://myst-parser.readthedocs.io/en/latest/syntax/optional.html?highlight=linkify#linkify
+sphinx-togglebutton
+sphinx-copybutton
+sphinxcontrib-bibtex>=2.4.1  # Version 2.4.1+ supports Python 3.10
+sphinxcontrib-spelling  # https://sphinxcontrib-spelling.readthedocs.io/en/latest/index.html
+sphinx-thebe
+sphinx-panels
+ablog
+pydata_sphinx_theme>=0.13.0
+sphinxemoji
 torch>=1.12.0
-sphinx-autodoc-typehints==1.12.0
-sphinxcontrib-applehelp==1.0.2
-sphinxcontrib-devhelp==1.0.2
-sphinxcontrib-htmlhelp==2.0.0
-sphinxcontrib-jsmath==1.0.1
-sphinxcontrib-qthelp==1.0.3
-sphinxcontrib-serializinghtml==1.1.5
-sphinxcontrib-mermaid==0.7.1
+sphinx-autodoc-typehints
+sphinxcontrib-applehelp
+sphinxcontrib-devhelp
+sphinxcontrib-htmlhelp
+sphinxcontrib-jsmath
+sphinxcontrib-qthelp
+sphinxcontrib-serializinghtml
+sphinxcontrib-mermaid

docs/source/conf.py

@@ -91,6 +91,7 @@
     "sphinx_autodoc_typehints",
     "sphinxcontrib.mermaid",
 ]
+bibtex_bibfiles = ['refs.bib']
 
 autoclass_content = "both"
 add_module_names = True
@@ -222,16 +223,17 @@
 # -- Options for myst-nb -------------------------------------------------
 #
 # (reference: https://myst-nb.readthedocs.io/en/latest/)
-# Prevent the following error
-#     MyST NB Configuration Error:
-#    `nb_render_priority` not set for builder: doctest
-nb_render_priority = {"doctest": ()}
 # Prevent creating jupyter_execute folder in dist
 #  https://myst-nb.readthedocs.io/en/latest/use/execute.html#executing-in-temporary-folders  # noqa
 execution_in_temp = True
 jupyter_execute_notebooks = "off"
 
 
+# -- Options for sphinxcontrib.bibtex -------------------------------------------------
+#
+# (reference: https://sphinxcontrib-bibtex.readthedocs.io/)
+bibtex_bibfiles = []  # Add bibliography files here if needed
+
 # -- Options for sphinxcontrib.spelling -------------------------------------------------
 #
 # (reference: https://sphinxcontrib-spelling.readthedocs.io/en/latest/customize.html)