From 91848049d5db4677b546cb94e32e9bbdf00923af Mon Sep 17 00:00:00 2001 From: Andrew Reusch Date: Wed, 16 Jun 2021 12:28:10 -0700 Subject: [PATCH] Fix bulleted lists in TVM documentation. * These currently do not render due to https://github.com/readthedocs/sphinx_rtd_theme/issues/1115 * Breakage was likely caused due to https://github.com/apache/tvm/issues/7995 --- docker/install/ubuntu_install_sphinx.sh | 3 ++- docs/README.txt | 4 ++-- python/gen_requirements.py | 5 ++++- 3 files changed, 8 insertions(+), 4 deletions(-) diff --git a/docker/install/ubuntu_install_sphinx.sh b/docker/install/ubuntu_install_sphinx.sh index 33757a0d4d57..80b3323d5956 100755 --- a/docker/install/ubuntu_install_sphinx.sh +++ b/docker/install/ubuntu_install_sphinx.sh @@ -20,4 +20,5 @@ set -e set -u set -o pipefail -pip3 install sphinx sphinx-gallery==0.4.0 autodocsumm sphinx_rtd_theme sphinx_autodoc_annotation matplotlib Image "commonmark>=0.7.3" "docutils>=0.11" +# NOTE: install docutils < 0.17 to work around https://github.com/readthedocs/sphinx_rtd_theme/issues/1115 +pip3 install sphinx sphinx-gallery==0.4.0 autodocsumm sphinx_rtd_theme sphinx_autodoc_annotation matplotlib Image "commonmark>=0.7.3" "docutils>=0.11" "docutils<0.17" diff --git a/docs/README.txt b/docs/README.txt index 1da0c833a256..06d7a0f6e444 100644 --- a/docs/README.txt +++ b/docs/README.txt @@ -3,7 +3,7 @@ TVM Documentations This folder contains the source of TVM documents - A hosted version of doc is at https://tvm.apache.org/docs -- pip install "sphinx>=1.5.5" sphinx-gallery sphinx_rtd_theme matplotlib Image recommonmark "Pillow<7" "autodocsumm<0.2.0" tlcpack-sphinx-addon +- pip install "sphinx>=1.5.5" sphinx-gallery sphinx_rtd_theme matplotlib Image recommonmark "Pillow<7" "autodocsumm<0.2.0" tlcpack-sphinx-addon "docutils<0.17" - (Versions 0.2.0 to 0.2.2 of autodocsumm are incompatible with sphinx>=3.4, https://github.com/Chilipp/autodocsumm/pull/42 ) - Build tvm first in the root folder. - Run the following command @@ -56,4 +56,4 @@ You will need a gpu CI environment. Define the Order of Tutorials ----------------------------- You can define the order of tutorials with `conf.py::subsection_order` and `conf.py::within_subsection_order`. -By default, the tutorials within one subsection is sorted by filename. \ No newline at end of file +By default, the tutorials within one subsection is sorted by filename. diff --git a/python/gen_requirements.py b/python/gen_requirements.py index 00dd4643190e..dc338a3fcd3b 100755 --- a/python/gen_requirements.py +++ b/python/gen_requirements.py @@ -201,7 +201,10 @@ ("coremltools", None), ("cpplint", None), ("decorator", None), - ("docutils", None), + ( + "docutils", + "<0.17", + ), # Work around https://github.com/readthedocs/sphinx_rtd_theme/issues/1115 ("future", None), ("image", None), ("matplotlib", None),