From 4f93f06055d94dcc522aa5b56eb4424d767b3a9a Mon Sep 17 00:00:00 2001 From: "ansible-zuul[bot]" <48994755+ansible-zuul[bot]@users.noreply.github.com> Date: Thu, 28 Oct 2021 21:26:46 +0000 Subject: [PATCH] Add configuration for Read the Docs build and pin docs requirements (#888) Due to a recent release of docutils 0.18, our doc build is broken. Add configuration for Read the Docs and pip docs requirements to ensure builds will not spontaneously break in the future. Update tox configuration to match the build done by Read the Docs. Reviewed-by: David Shrewsbury Reviewed-by: Sviatoslav Sydorenko Reviewed-by: Sam Doran Reviewed-by: Shane McDonald (cherry picked from commit cd69e4d1a06114c56c1e1a951784eaaa39a0556c) --- .readthedocs.yaml | 19 +++++++++++++++++++ docs/requirements.in | 5 +++++ docs/requirements.txt | 36 +++++++++++++++++++++++++++++++++--- tox.ini | 3 ++- 4 files changed, 59 insertions(+), 4 deletions(-) create mode 100644 .readthedocs.yaml create mode 100644 docs/requirements.in diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 000000000..585e4ad93 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,19 @@ +version: 2 + +formats: + - epub + - pdf + +build: + os: ubuntu-20.04 + tools: + python: '3.10' + +sphinx: + builder: dirhtml + configuration: docs/conf.py + fail_on_warning: true + +python: + install: + - requirements: docs/requirements.txt diff --git a/docs/requirements.in b/docs/requirements.in new file mode 100644 index 000000000..968452c10 --- /dev/null +++ b/docs/requirements.in @@ -0,0 +1,5 @@ +ansible-core +pbr +pexpect +six +sphinx diff --git a/docs/requirements.txt b/docs/requirements.txt index 52adc293f..3523137d2 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,3 +1,33 @@ -pbr -sphinx -ansible-core +alabaster==0.7.12 +ansible-core==2.11.6 +Babel==2.9.1 +certifi==2021.10.8 +cffi==1.15.0 +charset-normalizer==2.0.7 +cryptography==35.0.0 +docutils==0.17.1 +idna==3.3 +imagesize==1.2.0 +Jinja2==3.0.2 +MarkupSafe==2.0.1 +packaging==21.0 +pbr==5.6.0 +pexpect==4.8.0 +ptyprocess==0.7.0 +pycparser==2.20 +Pygments==2.10.0 +pyparsing==3.0.1 +pytz==2021.3 +PyYAML==6.0 +requests==2.26.0 +resolvelib==0.5.5 +six==1.16.0 +snowballstemmer==2.1.0 +Sphinx==4.2.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 +urllib3==1.26.7 diff --git a/tox.ini b/tox.ini index ce9115f66..484f6135c 100644 --- a/tox.ini +++ b/tox.ini @@ -27,5 +27,6 @@ commands= [testenv:docs] description = Build documentation deps = -r{toxinidir}/docs/requirements.txt +skip_install = True commands = - sphinx-build -E -W -d docs/build/doctrees -b html docs docs/build/html + sphinx-build -T -E -W --keep-going {tty:--color} -j auto -d docs/build/doctrees -b html docs docs/build/html