From 8236cdbf37a27a4bac9f097c25d37db87692596f Mon Sep 17 00:00:00 2001 From: Monty Taylor Date: Tue, 21 Aug 2018 08:57:12 -0500 Subject: [PATCH] Use doc/requirements and openstackdocstheme oslosphinx is the old hotness. openstackdocstheme is the new hotness. Also, we can use doc/requirements.txt for docs requirements. Change-Id: I9cbc670c8fb065d240251f061919479c87193ff5 --- doc/requirements.txt | 2 ++ doc/source/conf.py | 4 ++-- test-requirements.txt | 2 -- tox.ini | 3 +++ 4 files changed, 7 insertions(+), 4 deletions(-) create mode 100644 doc/requirements.txt diff --git a/doc/requirements.txt b/doc/requirements.txt new file mode 100644 index 00000000..c69cea6b --- /dev/null +++ b/doc/requirements.txt @@ -0,0 +1,2 @@ +sphinx!=1.6.6,!=1.6.7 # BSD +openstackdocstheme>=1.11.0 # Apache-2.0 diff --git a/doc/source/conf.py b/doc/source/conf.py index 42aa408f..5ff4600a 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -30,7 +30,7 @@ import os # ones. extensions = [ 'sphinx.ext.autodoc', - 'oslosphinx', + 'openstackdocstheme', ] # Add any paths that contain templates here, relative to this directory. @@ -92,7 +92,7 @@ pygments_style = 'sphinx' # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -html_theme = 'default' +html_theme = 'openstackdocs' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the diff --git a/test-requirements.txt b/test-requirements.txt index 41b80c10..6bc3c810 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -3,5 +3,3 @@ mock fixtures>=0.3.14 testrepository>=0.0.18 testtools>=0.9.34 -oslosphinx -sphinx>=1.1.2,!=1.2.0,<1.3 diff --git a/tox.ini b/tox.ini index 108f77cd..05cbda1c 100644 --- a/tox.ini +++ b/tox.ini @@ -22,6 +22,9 @@ commands = flake8 commands = python setup.py sdist {posargs} [testenv:docs] +deps = + -r{toxinidir}/requirements.txt + -r{toxinidir}/doc/requirements.txt commands = sphinx-build -W -d doc/build/doctrees -b html doc/source/ doc/build/html