Skip to content

Commit

Permalink
Fix bulleted lists in TVM documentation.
Browse files Browse the repository at this point in the history
 * These currently do not render due to
 readthedocs/sphinx_rtd_theme#1115
 * Breakage was likely caused due to apache#7995
  • Loading branch information
areusch committed Jun 22, 2021
1 parent 3cb838d commit 9184804
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 4 deletions.
3 changes: 2 additions & 1 deletion docker/install/ubuntu_install_sphinx.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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"
4 changes: 2 additions & 2 deletions docs/README.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.
By default, the tutorials within one subsection is sorted by filename.
5 changes: 4 additions & 1 deletion python/gen_requirements.py
Original file line number Diff line number Diff line change
Expand Up @@ -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),
Expand Down

0 comments on commit 9184804

Please sign in to comment.