summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSandra McCann <samccann@redhat.com>2021-08-11 10:05:13 -0400
committerGitHub <noreply@github.com>2021-08-11 09:05:13 -0500
commitd9a205f56edf052847eeeb5b38605f5268941ece (patch)
tree4141376578e39516b983756a42384002b7f52dbd
parent044279a28fdafd3d08a2fda1c7d86d6e0f3c13b5 (diff)
downloadansible-d9a205f56edf052847eeeb5b38605f5268941ece.tar.gz
add known-good requirements for docs (#75459)
-rw-r--r--docs/docsite/known_good_reqs.txt15
-rw-r--r--docs/docsite/requirements.txt3
2 files changed, 17 insertions, 1 deletions
diff --git a/docs/docsite/known_good_reqs.txt b/docs/docsite/known_good_reqs.txt
new file mode 100644
index 0000000000..0636694db5
--- /dev/null
+++ b/docs/docsite/known_good_reqs.txt
@@ -0,0 +1,15 @@
+# pip packages required to build docsite
+# tested August 10 2021
+
+docutils==0.16
+# check unordered lists when testing more recent docutils versions
+# see https://github.com/readthedocs/sphinx_rtd_theme/issues/1115
+jinja2==3.0.1
+Pygments==2.9.0
+PyYAML==5.4.1
+resolvelib==0.5.4
+rstcheck==3.3.1
+sphinx==3.5.4 # Won't work with >= 4 so picking most recent 3.x release
+sphinx-notfound-page==0.7.1 # must be >= 0.6
+sphinx-intl==2.0.1
+straight.plugin==1.5.0 # Needed for hacking/build-ansible.py which is the backend build script
diff --git a/docs/docsite/requirements.txt b/docs/docsite/requirements.txt
index 4ad3aa474f..bfb7cf0dce 100644
--- a/docs/docsite/requirements.txt
+++ b/docs/docsite/requirements.txt
@@ -1,8 +1,9 @@
#pip packages required to build docsite
+docutils == 0.16 # pin for now until the problem with unordered lists is fixed
jinja2
PyYAML
rstcheck
-sphinx
+sphinx < 4.0
sphinx-notfound-page
Pygments >= 2.4.0
straight.plugin # Needed for hacking/build-ansible.py which is the backend build script