diff options
| author | Hanxi Liu <hanxi.liu@easystack.cn> | 2017-06-23 11:11:39 +0800 |
|---|---|---|
| committer | Hanxi_Liu <hanxi.liu@easystack.cn> | 2017-07-12 23:39:32 +0800 |
| commit | 2bc27e6edf5cb377225d244a14f5c3a75acdbb19 (patch) | |
| tree | 49392810d96e5bdeefe1277d91c9dab555098766 | |
| parent | 3b4e35abada626ce052f20d55c71fe12ab77052a (diff) | |
| download | python-ceilometerclient-2bc27e6edf5cb377225d244a14f5c3a75acdbb19.tar.gz | |
Docs: switch to openstackdocstheme
Project documents are being reprocessed due to document migration[1].
Update the docs theme to openstackdocstheme instead of oslosphinx.
[1] https://review.openstack.org/#/c/472275/
Change-Id: Ic24ad9d7759ab9169bcc68db8c6d79e4bc69a76b
| -rw-r--r-- | doc/source/conf.py | 11 | ||||
| -rw-r--r-- | releasenotes/source/conf.py | 10 | ||||
| -rw-r--r-- | test-requirements.txt | 4 |
3 files changed, 20 insertions, 5 deletions
diff --git a/doc/source/conf.py b/doc/source/conf.py index bf45db6..00d4a79 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -24,7 +24,7 @@ gen_ref("v2", "Version 2 API Reference", # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. -extensions = ['sphinx.ext.autodoc', 'oslosphinx' ] +extensions = ['sphinx.ext.autodoc', 'openstackdocstheme'] # autodoc generation is a bit aggressive and a nuisance when doing heavy # text edit cycles. @@ -57,6 +57,15 @@ 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 = 'nature' +html_theme = 'openstackdocs' + +# openstackdocstheme options +repository_name = 'openstack/python-ceilometerclient' +bug_project = 'python-ceilometerclient' +bug_tag = '' + +# Must set this variable to include year, month, day, hours, and minutes. +html_last_updated_fmt = '%Y-%m-%d %H:%M' # Output file base name for HTML help builder. htmlhelp_basename = '%sdoc' % project diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index ecb154a..9ddac03 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -38,8 +38,8 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - 'oslosphinx', 'reno.sphinxext', + 'openstackdocstheme' ] # Add any paths that contain templates here, relative to this directory. @@ -112,7 +112,12 @@ 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' + +# openstackdocstheme options +repository_name = 'openstack/python-ceilometerclient' +bug_project = 'python-ceilometerclient' +bug_tag = '' # 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 +156,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 ca1a61a..b033e82 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -5,10 +5,10 @@ coverage>=3.6 # Apache-2.0 fixtures<2.0,>=1.3.1 # Apache-2.0/BSD mock>=1.2 # BSD -oslosphinx!=3.4.0,>=2.5.0 # Apache-2.0 +openstackdocstheme>=1.11.0 # Apache-2.0 reno>=1.6.2 # Apache2 python-subunit>=0.0.18 # Apache-2.0/BSD -sphinx!=1.2.0,!=1.3b1,<1.3,>=1.1.2 # BSD +sphinx>=1.6.2 # BSD tempest>=11.0.0 # Apache-2.0 testrepository>=0.0.18 # Apache-2.0/BSD testtools>=1.4.0 # MIT |