From 0c1ac4badbef1ca952e533807af07ca4fb7e30ce Mon Sep 17 00:00:00 2001 From: Van Hung Pham Date: Thu, 29 Jun 2017 11:39:48 +0700 Subject: [PATCH] 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: Icb985379c263d7d06544d69bae11282a18a7fc52 --- doc/source/conf.py | 19 +++++++++---------- releasenotes/source/conf.py | 10 ++++++++-- test-requirements.txt | 4 ++-- 3 files changed, 19 insertions(+), 14 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index 9d9ac368e..6714762e3 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -48,7 +48,7 @@ extensions = ['sphinx.ext.autodoc', 'sphinx.ext.ifconfig', 'sphinx.ext.graphviz', 'sphinx.ext.todo', - 'oslosphinx'] + 'openstackdocstheme',] todo_include_todos = True @@ -136,6 +136,7 @@ modindex_common_prefix = ['neutron_vpnaas.'] # Sphinx are currently 'default' and 'sphinxdoc'. # html_theme_path = ["."] # html_theme = '_theme' +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 @@ -168,15 +169,8 @@ modindex_common_prefix = ['neutron_vpnaas.'] # 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' -git_cmd = ["git", "log", "--pretty=format:'%ad, commit %h'", "--date=local", - "-n1"] -try: - html_last_updated_fmt = subprocess.Popen( - git_cmd, stdout=subprocess.PIPE).communicate()[0] -except Exception: - warnings.warn('Cannot get last updated time from git repository. ' - 'Not setting "html_last_updated_fmt".') +# 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. @@ -245,3 +239,8 @@ except Exception: # If false, no module index is generated. #latex_use_modindex = True + +# -- Options for openstackdocstheme ------------------------------------------- +repository_name = 'openstack/neutron-vpnaas' +bug_project = 'neutron' +bug_tag = 'doc' diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index b58346164..a5b0701ce 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/neutron-vpnaas' +bug_project = 'neutron' +bug_tag = 'doc' diff --git a/test-requirements.txt b/test-requirements.txt index 2c521469a..da3575bc5 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -10,8 +10,8 @@ mock>=2.0 # BSD pylint==1.4.5 # GPLv2 python-subunit>=0.0.18 # Apache-2.0/BSD requests-mock>=1.1 # Apache-2.0 -sphinx!=1.6.1,>=1.5.1 # BSD -oslosphinx>=4.7.0 # Apache-2.0 +sphinx>=1.6.2 # BSD +openstackdocstheme>=1.11.0 # Apache-2.0 testrepository>=0.0.18 # Apache-2.0/BSD tempest>=14.0.0 # Apache-2.0 testtools>=1.4.0 # MIT