summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDong Ma <winterma.dong@gmail.com>2017-07-01 08:51:47 +0800
committerDong Ma <winterma.dong@gmail.com>2017-07-01 08:51:47 +0800
commitbd35a6e841550cb01c4bbf94979805369474db54 (patch)
tree38905a2403018a7d9fa5d4bb732142becc4caab5
parentfe64db1d45fdf3ea9e6b9a7524d24f8626aae2af (diff)
downloadoslo-db-bd35a6e841550cb01c4bbf94979805369474db54.tar.gz
switch from oslosphinx to openstackdocstheme
Change-Id: I66319c2b4e4ec4c10133151f7a867bdca7a3afa8
-rwxr-xr-xdoc/source/conf.py11
-rw-r--r--releasenotes/source/conf.py10
-rw-r--r--setup.cfg2
3 files changed, 17 insertions, 6 deletions
diff --git a/doc/source/conf.py b/doc/source/conf.py
index 00f65cb..576e270 100755
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -23,9 +23,16 @@ extensions = [
'sphinx.ext.autodoc',
#'sphinx.ext.intersphinx',
'oslo_config.sphinxext',
- 'oslosphinx',
+ 'openstackdocstheme',
'stevedore.sphinxext'
]
+# openstackdocstheme options
+repository_name = 'openstack/oslo.db'
+bug_project = 'oslo.db'
+bug_tag = ''
+
+# Must set this variable to include year, month, day, hours, and minutes.
+html_last_updated_fmt = '%Y-%m-%d %H:%M'
# autodoc generation is a bit aggressive and a nuisance when doing heavy
# text edit cycles.
@@ -66,7 +73,7 @@ modindex_common_prefix = ['oslo_db.']
# 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 = 'openstackdocs'
# html_static_path = ['static']
# Output file base name for HTML help builder.
diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py
index e5cc22e..eb70f78 100644
--- a/releasenotes/source/conf.py
+++ b/releasenotes/source/conf.py
@@ -38,9 +38,13 @@
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
- 'oslosphinx',
+ 'openstackdocstheme',
'reno.sphinxext',
]
+# openstackdocstheme options
+repository_name = 'openstack/oslo.db'
+bug_project = 'oslo.db'
+bug_tag = ''
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
@@ -112,7 +116,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
@@ -150,7 +154,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/setup.cfg b/setup.cfg
index 7cf8266..9f3ea27 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -38,7 +38,7 @@ test =
mock>=2.0 # BSD
python-subunit>=0.0.18 # Apache-2.0/BSD
sphinx>=1.6.2 # BSD
- oslosphinx>=4.7.0 # Apache-2.0
+ openstackdocstheme>=1.11.0 # Apache-2.0
oslotest>=1.10.0 # Apache-2.0
oslo.context>=2.14.0 # Apache-2.0
testrepository>=0.0.18 # Apache-2.0/BSD