summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorVan Hung Pham <hungpv@vn.fujitsu.com>2017-06-29 10:40:24 +0700
committerVan Hung Pham <hungpv@vn.fujitsu.com>2017-06-29 10:40:24 +0700
commit3ce185402ede727be4759e6f64813dace6167b89 (patch)
tree902bd3b1f77b68e04a790d510b8511e26c53d9e0
parentbfb9ec786bbc4d6d813c5aeb0327dd6a7bb8bf08 (diff)
downloadoslo-context-3ce185402ede727be4759e6f64813dace6167b89.tar.gz
Switch from oslosphinx to openstackdocstheme2.16.0
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: I2ac1a1b9899b8bcb939fb287f09e7c69caca7fc9
-rwxr-xr-xdoc/source/conf.py14
-rw-r--r--releasenotes/source/conf.py10
-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 ca1f348..11d61e5 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
@@ -55,8 +55,13 @@ 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
@@ -71,5 +76,10 @@ latex_documents = [
u'OpenStack Foundation', 'manual'),
]
+# openstackdocstheme options
+repository_name = 'openstack/oslo.context'
+bug_project = 'oslo.context'
+bug_tag = ''
+
# 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 5e91ef7..c0c9104 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.
@@ -274,3 +275,8 @@ texinfo_documents = [
# -- Options for Internationalization output ------------------------------
locale_dirs = ['locale/']
+
+# openstackdocstheme options
+repository_name = 'openstack/oslo.context'
+bug_project = 'oslo.context'
+bug_tag = ''
diff --git a/test-requirements.txt b/test-requirements.txt
index b9ace0c..c64e166 100644
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -8,6 +8,6 @@ oslotest>=1.10.0 # Apache-2.0
coverage!=4.4,>=4.0 # Apache-2.0
# These are needed for docs generation
-oslosphinx>=4.7.0 # Apache-2.0
+openstackdocstheme>=1.11.0 # Apache-2.0
sphinx>=1.6.2 # BSD
reno!=2.3.1,>=1.8.0 # Apache-2.0