summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorVan Hung Pham <hungpv@vn.fujitsu.com>2017-06-27 12:20:48 +0000
committerVan Hung Pham <hungpv@vn.fujitsu.com>2017-06-30 10:49:51 +0700
commit9c7d4f8f03faf7f0b16757feb3703504b3d93d6b (patch)
tree7c4d820fedcb12c74e2ebb6f5960a0f4227fa772
parentcb641f70f48758f4f532271e81e324fd79a97a7a (diff)
downloadoslotest-9c7d4f8f03faf7f0b16757feb3703504b3d93d6b.tar.gz
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: If8e423b05eac3a8477997833439af74cd3ae7e58
-rwxr-xr-xdoc/source/conf.py15
-rw-r--r--releasenotes/source/conf.py9
-rw-r--r--test-requirements.txt2
3 files changed, 21 insertions, 5 deletions
diff --git a/doc/source/conf.py b/doc/source/conf.py
index 090e478..d452b4e 100755
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -23,7 +23,7 @@ sys.path.insert(0, os.path.abspath('../..'))
extensions = [
'sphinx.ext.autodoc',
#'sphinx.ext.intersphinx',
- 'oslosphinx'
+ 'openstackdocstheme',
]
# autodoc generation is a bit aggressive and a nuisance when doing heavy
@@ -56,12 +56,22 @@ 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_static_path = ['static']
+html_theme = 'openstackdocs'
+
+# 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'
# Output file base name for HTML help builder.
htmlhelp_basename = '%sdoc' % project
+# openstackdocstheme options
+repository_name = 'openstack/oslotest'
+bug_project = 'oslotest'
+bug_tag = ''
+
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass
# [howto/manual]).
@@ -74,3 +84,4 @@ latex_documents = [
# Example configuration for intersphinx: refer to the Python standard library.
#intersphinx_mapping = {'http://docs.python.org/': None}
+
diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py
index 02fd74d..9e83602 100644
--- a/releasenotes/source/conf.py
+++ b/releasenotes/source/conf.py
@@ -35,7 +35,7 @@
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
- 'oslosphinx',
+ 'openstackdocstheme',
'reno.sphinxext',
]
@@ -109,7 +109,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
@@ -148,6 +148,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.
@@ -189,6 +190,10 @@ html_static_path = ['_static']
# Output file base name for HTML help builder.
htmlhelp_basename = 'oslotestReleaseNotesDoc'
+# openstackdocstheme options
+repository_name = 'openstack/oslotest'
+bug_project = 'oslotest'
+bug_tag = ''
# -- Options for LaTeX output ---------------------------------------------
diff --git a/test-requirements.txt b/test-requirements.txt
index 6591044..30c7b1c 100644
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -11,7 +11,7 @@ coverage!=4.4,>=4.0 # Apache-2.0
# this is required for the docs build jobs
sphinx>=1.6.2 # BSD
-oslosphinx>=4.7.0 # Apache-2.0
+openstackdocstheme>=1.11.0 # Apache-2.0
oslo.config!=4.3.0,!=4.4.0,>=4.0.0 # Apache-2.0
reno!=2.3.1,>=1.8.0 # Apache-2.0