summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAkihiro Motoki <amotoki@gmail.com>2017-07-01 20:12:46 +0900
committerAkihiro Motoki <amotoki@gmail.com>2017-07-01 21:05:48 +0900
commitd14dfdf5c4eca410d3da165611d21142828fb560 (patch)
treef0d6f63e220c40bae9e22f68c93b17b84188ed07
parent98ae7d5c2d74b40f298175092526b05ee865f1ce (diff)
downloadoslo-utils-d14dfdf5c4eca410d3da165611d21142828fb560.tar.gz
switch from oslosphinx to openstackdocstheme
Change-Id: Ief1b96ec6d08552f285540a68994c70cc9af3098
-rwxr-xr-xdoc/source/conf.py13
-rw-r--r--releasenotes/source/conf.py11
-rw-r--r--test-requirements.txt2
3 files changed, 19 insertions, 7 deletions
diff --git a/doc/source/conf.py b/doc/source/conf.py
index 352863e..25a0146 100755
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -22,10 +22,14 @@ sys.path.insert(0, os.path.abspath('../..'))
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = [
'sphinx.ext.autodoc',
- #'sphinx.ext.intersphinx',
- 'oslosphinx'
+ 'openstackdocstheme'
]
+# openstackdocstheme options
+repository_name = 'openstack/oslo.utils'
+bug_project = 'oslo.utils'
+bug_tag = ''
+
# autodoc generation is a bit aggressive and a nuisance when doing heavy
# text edit cycles.
# execute "export SPHINX_DEBUG=1" in your terminal to disable
@@ -57,6 +61,9 @@ pygments_style = 'sphinx'
# html_theme_path = ["."]
# html_theme = '_theme'
# html_static_path = ['static']
+html_theme = 'openstackdocs'
+
+html_last_updated_fmt = '%Y-%m-%d %H:%M'
# Output file base name for HTML help builder.
htmlhelp_basename = '%sdoc' % project
@@ -72,4 +79,4 @@ latex_documents = [
]
# Example configuration for intersphinx: refer to the Python standard library.
-#intersphinx_mapping = {'http://docs.python.org/': None} \ No newline at end of file
+#intersphinx_mapping = {'http://docs.python.org/': None}
diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py
index 2fd2406..2f2fff7 100644
--- a/releasenotes/source/conf.py
+++ b/releasenotes/source/conf.py
@@ -35,10 +35,15 @@
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
- 'oslosphinx',
+ 'openstackdocstheme',
'reno.sphinxext',
]
+# openstackdocstheme options
+repository_name = 'openstack/oslo.utils'
+bug_project = 'oslo.utils'
+bug_tag = ''
+
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
@@ -109,7 +114,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
@@ -147,7 +152,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 840aee7..0fff514 100644
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -18,7 +18,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
# mocking framework
mock>=2.0 # BSD