summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorShahzeb Siddiqui <shahzebmsiddiqui@gmail.com>2021-10-18 12:55:46 -0400
committerGitHub <noreply@github.com>2021-10-18 16:55:46 +0000
commit3c013b5be6775c7c337fda596119499d8c624ba7 (patch)
tree7e439257997d3ef0e2280ebf5df4d0ed5f7bf1d9
parent30e8dd95b54bb60b0b696ec85fb7f9b71f5e79dc (diff)
downloadspack-3c013b5be6775c7c337fda596119499d8c624ba7.tar.gz
spack-3c013b5be6775c7c337fda596119499d8c624ba7.tar.bz2
spack-3c013b5be6775c7c337fda596119499d8c624ba7.tar.xz
spack-3c013b5be6775c7c337fda596119499d8c624ba7.zip
docutils > 0.17 issue with rendering list items in sphinx (#26355)
* downgrade_docutils_version * invalid version * Update requirements.txt * Improve spelling and shorten the reference link * Update spack.yaml * update version requirement * update version to maximum of 0.16 Co-authored-by: bernhardkaindl <43588962+bernhardkaindl@users.noreply.github.com>
-rw-r--r--lib/spack/docs/requirements.txt3
-rw-r--r--lib/spack/docs/spack.yaml1
2 files changed, 4 insertions, 0 deletions
diff --git a/lib/spack/docs/requirements.txt b/lib/spack/docs/requirements.txt
index 5eee3b8b5a..b0d91dfc97 100644
--- a/lib/spack/docs/requirements.txt
+++ b/lib/spack/docs/requirements.txt
@@ -5,3 +5,6 @@ sphinx>=3.4,!=4.1.2
sphinxcontrib-programoutput
sphinx-rtd-theme
python-levenshtein
+# Restrict to docutils <0.17 to workaround a list rendering issue in sphinx.
+# https://stackoverflow.com/questions/67542699
+docutils <0.17
diff --git a/lib/spack/docs/spack.yaml b/lib/spack/docs/spack.yaml
index 8f3fd53e8b..153eba9ada 100644
--- a/lib/spack/docs/spack.yaml
+++ b/lib/spack/docs/spack.yaml
@@ -17,6 +17,7 @@ spack:
# Sphinx
- "py-sphinx@3.4:4.1.1,4.1.3:"
- py-sphinxcontrib-programoutput
+ - py-docutils@:0.16
- py-sphinx-rtd-theme
# VCS
- git