From 35068ac7eaffae458d3df97db7c670eb9b42aa84 Mon Sep 17 00:00:00 2001 From: Emilien Macchi Date: Tue, 27 Jun 2017 16:29:18 -0400 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: I497a3d33d70a6464ab642f7b1009efe19ba4ea8e --- doc/source/conf.py | 12 +++++++----- releasenotes/source/conf.py | 12 +++++++----- test-requirements.txt | 4 ++-- 3 files changed, 16 insertions(+), 12 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index 2fb9a7091..fdcac593d 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -26,7 +26,7 @@ # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. -extensions = ['oslosphinx'] +extensions = ['openstackdocstheme'] templates_path = ['_templates'] # The suffix of source filenames. source_suffix = '.rst' @@ -74,9 +74,6 @@ exclude_patterns = ['_build'] # output. They are ignored by default. # show_authors = False -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' - # A list of ignored prefixes for module index sorting. # modindex_common_prefix = [] @@ -88,7 +85,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 @@ -240,3 +237,8 @@ texinfo_documents = [ # If true, do not generate a @detailmenu in the "Top" node's menu. # texinfo_no_detailmenu = False + +# openstackdocstheme options +repository_name = 'openstack/tripleo-image-elements' +bug_project = 'tripleo' +bug_tag = 'documentation' diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index 0a840cd18..ad735c908 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -27,7 +27,7 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - 'oslosphinx', + 'openstackdocstheme', 'reno.sphinxext', ] @@ -87,9 +87,6 @@ exclude_patterns = [] # output. They are ignored by default. #show_authors = False -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' - # A list of ignored prefixes for module index sorting. #modindex_common_prefix = [] @@ -101,7 +98,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 @@ -262,3 +259,8 @@ texinfo_documents = [ # -- Options for Internationalization output ------------------------------ locale_dirs = ['locale/'] + +# openstackdocstheme options +repository_name = 'openstack/tripleo-image-elements' +bug_project = 'tripleo' +bug_tag = 'documentation' diff --git a/test-requirements.txt b/test-requirements.txt index 4c9a6025b..5c2264a49 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -1,7 +1,7 @@ hacking>=0.9.2,<0.10 +openstackdocstheme>=1.11.0 # Apache-2.0 oslotest -oslosphinx -sphinx>=1.1.2,<1.2 +sphinx>=1.6.2 # BSD testrepository>=0.0.18 reno>=1.8.0 # Apache-2.0