From c97995dc9fa97c934d64c577177a741ef4e5779c Mon Sep 17 00:00:00 2001 From: Federico Ressi Date: Mon, 27 May 2019 04:38:31 +0200 Subject: [PATCH] Update docs requirements and fix link - update documentation building requirement - fix broken link in documentation page Change-Id: I3b17aac420233b027acc14666fb50fdbd220b26d --- doc/requirements.txt | 3 ++- doc/source/index.rst | 2 +- tox.ini | 21 ++++++++++++++------- 3 files changed, 17 insertions(+), 9 deletions(-) diff --git a/doc/requirements.txt b/doc/requirements.txt index 0404964ea..569de3189 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -5,5 +5,6 @@ oslotest>=3.2.0 # Apache-2.0 oslo.log>=3.36.0 # Apache-2.0 reno>=2.5.0 # Apache-2.0 -sphinx!=1.6.6,>=1.6.2 # BSD +sphinx!=1.6.6,!=1.6.7,>=1.6.2,<2.0.0;python_version=='2.7' # BSD +sphinx!=1.6.6,!=1.6.7,>=1.6.2;python_version>='3.4' # BSD sphinx_rtd_theme>=0.4.2,< 1 # Apache-2.0 diff --git a/doc/source/index.rst b/doc/source/index.rst index 7943b7f88..14f8802ff 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -12,7 +12,7 @@ You can look for additional documentation also in the `OpenStack wiki `__. This documentation is generated by the Sphinx toolkit and lives in the `source -tree `__. +tree `__. Enjoy! diff --git a/tox.ini b/tox.ini index 45f57c9de..1eb5efedb 100644 --- a/tox.ini +++ b/tox.ini @@ -142,27 +142,34 @@ commands = {posargs} # --- documentation environments ---------------------------------------------- -[testenv:docs] +[docs] basepython = python3 envdir = {toxworkdir}/docs deps = -r{toxinidir}/doc/requirements.txt + + +[testenv:docs] + +basepython = {[docs]basepython} +envdir = {[docs]envdir} +deps = {[docs]deps} commands = sphinx-build -W -b html doc/source doc/build/html [testenv:linkcheck] -basepython = python3 -envdir = {toxworkdir}/docs -deps = {[testenv:docs]deps} +basepython = {[docs]basepython} +envdir = {[docs]envdir} +deps = {[docs]deps} commands = sphinx-build -W -b linkcheck doc/source doc/build/linkcheck [testenv:releasenotes] -basepython = python3 -envdir = {toxworkdir}/docs -deps = {[testenv:docs]deps} +basepython = {[docs]basepython} +envdir = {[docs]envdir} +deps = {[docs]deps} commands = sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html