Browse Source

Add ansible requirement to our docs builds

This change combines the docs and molecule requirements files. This is
being done because the zuul publishing job does not use tox to render
documentation so we're not able to combine the two requirements files
via the tox interface. To ensure we're not creating duplicate
requirements, which could be frustrating to maintain in the future,
we're linking doc/requirements.txt to molecule-requirements.txt and
combining the package lists.

Change-Id: If7977ad06bf0775834a15e6274ae6457e4601fa6
Signed-off-by: Kevin Carter <kecarter@redhat.com>
changes/67/670167/3
Kevin Carter 2 years ago
parent
commit
32aed164b9
No known key found for this signature in database GPG Key ID: CE94BD890A47B20A
  1. 10
      doc/requirements.txt
  2. 1
      doc/requirements.txt
  3. 0
      doc/source/_exts/.gitkeep
  4. 8
      molecule-requirements.txt
  5. 3
      tox.ini

10
doc/requirements.txt

@ -1,10 +0,0 @@
# The order of packages is significant, because pip processes them in the order
# of appearance. Changing the order has an impact on the overall integration
# process, which may cause wedges in the gate later.
# this is required for the docs build jobs
sphinx>=2.0.0 # BSD
openstackdocstheme>=1.29.2 # Apache-2.0
reno>=2.11.3 # Apache-2.0
doc8>=0.8.0 # Apache-2.0
bashate>=0.6.0 # Apache-2.0

1
doc/requirements.txt

@ -0,0 +1 @@
../molecule-requirements.txt

0
doc/source/_exts/.gitkeep

8
molecule-requirements.txt

@ -1,3 +1,4 @@
# this is required for the molecule jobs
ansible
ansi2html
docker
@ -7,3 +8,10 @@ pytest-html
pytest-xdist
mock
molecule>=2.22rc1
# this is required for the docs build jobs
sphinx>=2.0.0 # BSD
openstackdocstheme>=1.29.2 # Apache-2.0
reno>=2.11.3 # Apache-2.0
doc8>=0.8.0 # Apache-2.0
bashate>=0.6.0 # Apache-2.0

3
tox.ini

@ -96,8 +96,7 @@ commands =
[testenv:docs]
basepython = python3
deps =
-r{toxinidir}/doc/requirements.txt
-r{toxinidir}/molecule-requirements.txt
-r {toxinidir}/doc/requirements.txt
commands=
doc8 doc
sphinx-build -a -E -W -d doc/build/doctrees -b html doc/source doc/build/html -T

Loading…
Cancel
Save