From a643acbf62c66bad49183b9e67a07fa4d6f20aca Mon Sep 17 00:00:00 2001
From: ZhongShengping <chdzsp@163.com>
Date: Mon, 26 Jun 2017 12:34:01 +0800
Subject: [PATCH] Switch from oslosphinx to openstackdocstheme
As part of the docs migration work[0] for Pike we need to switch to use the
openstackdocstheme.
[0]https://review.openstack.org/#/c/472275/
Change-Id: Id63951348211bdcb2b189455968bdfed40857815
---
doc/conf.py | 14 +++++++++++---
releasenotes/source/conf.py | 6 +++---
test-requirements.txt | 1 -
3 files changed, 14 insertions(+), 7 deletions(-)
diff --git a/doc/conf.py b/doc/conf.py
index 0a39ce7aa..7219f5feb 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -21,8 +21,8 @@ sys.path.insert(0, os.path.abspath('../..'))
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = [
+ 'openstackdocstheme',
'sphinx.ext.autodoc',
- 'oslosphinx'
]
# autodoc generation is a bit aggressive and a nuisance when doing heavy
@@ -64,13 +64,16 @@ pygments_style = 'sphinx'
# The theme to use for HTML and HTML Help pages. Major themes that come with
# Sphinx are currently 'default' and 'sphinxdoc'.
-# html_theme_path = ["."]
-# html_theme = '_theme'
+# html_theme_path = []
+html_theme = 'openstackdocs'
# html_static_path = ['static']
# Output file base name for HTML help builder.
htmlhelp_basename = '%sdoc' % project
+# Must set this variable to include year, month, day, hours, and minutes.
+html_last_updated_fmt = '%Y-%m-%d %H:%M'
+
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass
# [howto/manual]).
@@ -80,3 +83,8 @@ latex_documents = [
u'%s Documentation' % project,
u'OpenStack Foundation', 'manual'),
]
+
+# openstackdocstheme options
+repository_name = 'openstack/kolla-ansible'
+bug_project = 'kolla-ansible'
+bug_tag = ''
diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py
index 6c7d3581c..1574433dc 100644
--- a/releasenotes/source/conf.py
+++ b/releasenotes/source/conf.py
@@ -30,7 +30,7 @@ sys.path.insert(0, os.path.abspath('../..'))
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
- 'oslosphinx',
+ 'openstackdocstheme',
'reno.sphinxext',
]
@@ -102,7 +102,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
@@ -140,7 +140,7 @@ html_static_path = ['_static']
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
-# html_last_updated_fmt = '%b %d, %Y'
+html_last_updated_fmt = '%Y-%m-%d %H:%M'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
diff --git a/test-requirements.txt b/test-requirements.txt
index c3654cda7..2ce13c104 100644
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -11,7 +11,6 @@ hacking>=0.10.0
openstackdocstheme>=1.11.0 # Apache-2.0
oslo.log>=3.22.0 # Apache-2.0
oslotest>=1.10.0 # Apache-2.0
-oslosphinx>=4.7.0 # Apache-2.0
reno!=2.3.1,>=1.8.0 # Apache-2.0
PrettyTable<0.8,>=0.7.1 # BSD
PyYAML>=3.10.0 # MIT
--
GitLab