From 882b0ec0b4edb79debb45940bee92eaa472a4e68 Mon Sep 17 00:00:00 2001
From: Andreas Jaeger <aj@suse.com>
Date: Thu, 27 Dec 2018 19:20:42 +0100
Subject: [PATCH] Use openstackdocstheme

Use openstackdocstheme for consistency with all specs displayed on
specs.openstack.org.

This includes updating requirements to current versions, updating specs
building to not publish dirtrees and tread warnings as errors, update
index page, and update settings for the theme.

Change-Id: I905f404361a98d9af1a4ba5c52b8e04acda1688e
---
 doc/source/conf.py   | 18 ++++++++----------
 doc/source/index.rst |  4 ++++
 requirements.txt     |  6 +++---
 tox.ini              |  2 +-
 4 files changed, 16 insertions(+), 14 deletions(-)

diff --git a/doc/source/conf.py b/doc/source/conf.py
index f32888a..fea695b 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -19,18 +19,16 @@ import sys
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
-sys.path.insert(0, os.path.abspath('.'))
+# sys.path.insert(0, os.path.abspath('.'))
 
 # -- General configuration -----------------------------------------------------
 #
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 extensions = [
-    'sphinx.ext.autodoc',
     'sphinx.ext.todo',
-    'sphinx.ext.viewcode',
     'sphinx.ext.graphviz',
-    # 'oslosphinx',
+    'openstackdocstheme',
     'yasfb',
 ]
 
@@ -48,6 +46,11 @@ try:
 except ImportError:
     pass
 
+# openstackdocstheme options
+html_theme = 'openstackdocs'
+repository_name = 'openstack/vitrage-specs'
+use_storyboard = True
+
 # The suffix of source filenames.
 source_suffix = '.rst'
 
@@ -130,11 +133,6 @@ man_pages = []
 # pixels large.
 #html_favicon = None
 
-# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
-# using the given strftime format.
-git_cmd = "git log --pretty=format:'%ad, commit %h' --date=local -n1"
-html_last_updated_fmt = os.popen(git_cmd).read()
-
 # If true, SmartyPants will be used to convert quotes and dashes to
 # typographically correct entities.
 #html_use_smartypants = True
@@ -278,4 +276,4 @@ epub_copyright = u'2014, OpenStack Vitrage Team'
 #epub_tocdepth = 3
 
 # Allow duplicate toc entries.
-#epub_tocdup = True
\ No newline at end of file
+#epub_tocdup = True
diff --git a/doc/source/index.rst b/doc/source/index.rst
index ae2d6b7..d0e4ebd 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -1,8 +1,12 @@
 .. vitrage-specs documentation master file
 
+==============================
 Vitrage Project Specifications
 ==============================
 
+Specifications
+==============
+
 Mitaka
 ------
 
diff --git a/requirements.txt b/requirements.txt
index 785979e..5066bbd 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -2,10 +2,10 @@
 # of appearance. Changing the order has an impact on the overall integration
 # process, which may cause wedges in the gate later.
 
-pbr<2.0,>=0.11
-sphinx>=1.1.2,!=1.2.0,!=1.3b1,<1.3
+pbr!=2.1.0  # Apache-2.0
+sphinx!=1.6.6,!=1.6.7  # BSD
 graphviz>=0.4,!=0.5.0  # MIT License
 stestr>=2.0.0
 testtools>=0.9.34
 yasfb
-sphinx-autobuild
+openstackdocstheme>=1.28.0  # Apache-2.0
diff --git a/tox.ini b/tox.ini
index 19f80ca..95dc08f 100644
--- a/tox.ini
+++ b/tox.ini
@@ -19,7 +19,7 @@ basepython = python3
 deps =
     -c{env:UPPER_CONSTRAINTS_FILE:https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt}
     -r{toxinidir}/requirements.txt
-commands = sphinx-build -b html doc/source doc/build/html
+commands = sphinx-build -W -E -b html -d doc/build/doctrees doc/source doc/build/html
 
 [testenv:doc8]
 basepython = python3