diff options
author | Van Hung Pham <hungpv@vn.fujitsu.com> | 2017-07-03 13:31:42 +0700 |
---|---|---|
committer | Van Hung Pham <hungpv@vn.fujitsu.com> | 2017-07-14 13:24:45 +0700 |
commit | 16a75e8e353be33177c0bc8148029cb35599d29c (patch) | |
tree | 31e26e85d1b1f030eeda65c73306765fdee7d560 | |
parent | bb5c120460b0c657ceea82245ff8f13f5f64ec7f (diff) | |
download | python-cinderclient-16a75e8e353be33177c0bc8148029cb35599d29c.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: Ie5930c73c748bb308940606fced8f84eecdecdc8
-rw-r--r-- | doc/source/conf.py | 14 | ||||
-rw-r--r-- | releasenotes/source/conf.py | 10 | ||||
-rw-r--r-- | test-requirements.txt | 2 |
3 files changed, 21 insertions, 5 deletions
diff --git a/doc/source/conf.py b/doc/source/conf.py index e19f38b..1af8db5 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -43,7 +43,7 @@ sys.path.insert(0, ROOT) # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. extensions = [ 'sphinx.ext.autodoc', - 'oslosphinx', + 'openstackdocstheme', 'reno.sphinxext', ] @@ -120,6 +120,7 @@ man_pages = [ # The theme to use for HTML and HTML Help pages. Major themes that come with # Sphinx are currently 'default' and 'sphinxdoc'. # html_theme = 'nature' +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 @@ -188,6 +189,10 @@ html_static_path = ['_static'] # Output file base name for HTML help builder. htmlhelp_basename = 'python-cinderclientdoc' +# 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' # -- Options for LaTeX output ------------------------------------------------- @@ -220,4 +225,9 @@ latex_documents = [ # latex_appendices = [] # If false, no module index is generated. -# latex_use_modindex = True
\ No newline at end of file +# latex_use_modindex = True + +# -- Options for openstackdocstheme ------------------------------------------- +repository_name = 'openstack/python-cinderclient' +bug_project = 'cinderclient' +bug_tag = '' diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index ffd5111..2623c9e 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -38,7 +38,7 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - 'oslosphinx', + 'openstackdocstheme', 'reno.sphinxext', ] @@ -112,7 +112,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 @@ -151,6 +151,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. @@ -277,3 +278,8 @@ texinfo_documents = [ # -- Options for Internationalization output ------------------------------ locale_dirs = ['locale/'] + +# -- Options for openstackdocstheme ------------------------------------------- +repository_name = 'openstack/python-cinderclient' +bug_project = 'cinderclient' +bug_tag = '' diff --git a/test-requirements.txt b/test-requirements.txt index 9ce8f4f..07d828d 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -7,7 +7,7 @@ coverage!=4.4,>=4.0 # Apache-2.0 ddt>=1.0.1 # MIT fixtures>=3.0.0 # Apache-2.0/BSD mock>=2.0 # BSD -oslosphinx>=4.7.0 # Apache-2.0 +openstackdocstheme>=1.11.0 # Apache-2.0 python-subunit>=0.0.18 # Apache-2.0/BSD reno!=2.3.1,>=1.8.0 # Apache-2.0 requests-mock>=1.1 # Apache-2.0 |