From 1583bdaf7bd9193e19663b0f6ffd0225fdab7986 Mon Sep 17 00:00:00 2001 From: Eyal Date: Mon, 4 Jan 2021 17:51:16 +0200 Subject: [PATCH] add requirements to doc Change-Id: I3320623bce9a3351cac91d5b4c1d30fbb999e5b1 --- doc/requirements.txt | 5 +++++ tox.ini | 12 ++++++++++-- 2 files changed, 15 insertions(+), 2 deletions(-) create mode 100644 doc/requirements.txt diff --git a/doc/requirements.txt b/doc/requirements.txt new file mode 100644 index 0000000..73ee25e --- /dev/null +++ b/doc/requirements.txt @@ -0,0 +1,5 @@ +sphinx>=2.0.0,!=2.1.0 # BSD +sphinxcontrib-httpdomain>=1.3.0 # BSD +sphinxcontrib-pecanwsme>=0.8.0 # Apache-2.0 +openstackdocstheme>=2.2.1 # Apache-2.0 +reno>=3.1.0 # Apache-2.0 diff --git a/tox.ini b/tox.ini index a85b7c9..76bf297 100644 --- a/tox.ini +++ b/tox.ini @@ -35,11 +35,19 @@ commands = coverage xml -o cover/coverage.xml [testenv:docs] -commands = sphinx-build -W -b html doc/source doc/build/html +deps = -r{toxinidir}/doc/requirements.txt +whitelist_externals = + rm +commands = + rm -fr doc/build + sphinx-build -E -W --keep-going -b html doc/source doc/build/html [testenv:releasenotes] +whitelist_externals = + rm commands = - sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html + rm -rf releasenotes/build + sphinx-build -a -E -W -d releasenotes/build/doctrees --keep-going -b html releasenotes/source releasenotes/build/html [testenv:debug] commands = oslo_debug_helper {posargs}