openstack/tripleo-puppet-elements
Code Issues Proposed changes

Switch from oslosphinx to openstackdocstheme

Browse Source 
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: Iffe8047944add2d8f63cb8031a633c1fe8fff09c
This commit is contained in:
Emilien Macchi 2017-06-27 16:30:55 -04:00
parent 9285877b2a
commit 0df6e75da7
3 changed files with 17 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/source/conf.py
View File

@ -24,7 +24,7 @@
# Add any Sphinx extension module names here, as strings. They can be # Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones. # ones.
extensions = ['oslosphinx'] extensions = ['openstackdocstheme']
templates_path = ['_templates'] templates_path = ['_templates']
# The suffix of source filenames. # The suffix of source filenames.
source_suffix = '.rst' source_suffix = '.rst'
@ -86,7 +86,7 @@ pygments_style = 'sphinx'
# The theme to use for HTML and HTML Help pages. See the documentation for # The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes. # 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 # 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 # further. For a list of options available for each theme, see the
@ -238,3 +238,8 @@ texinfo_documents = [
# If true, do not generate a @detailmenu in the "Top" node's menu. # If true, do not generate a @detailmenu in the "Top" node's menu.
# texinfo_no_detailmenu = False # texinfo_no_detailmenu = False
# openstackdocstheme options
repository_name = 'openstack/tripleo-puppet-elements'
bug_project = 'tripleo'
bug_tag = 'documentation'

10
releasenotes/source/conf.py
View File

@ -27,7 +27,7 @@
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones. # ones.
extensions = [ extensions = [
'oslosphinx', 'openstackdocstheme',
'reno.sphinxext', 'reno.sphinxext',
] ]
@ -102,7 +102,8 @@ pygments_style = 'sphinx'
# The theme to use for HTML and HTML Help pages. See the documentation for # The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes. # 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 # 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 # further. For a list of options available for each theme, see the
@ -263,3 +264,8 @@ texinfo_documents = [
# -- Options for Internationalization output ------------------------------ # -- Options for Internationalization output ------------------------------
locale_dirs = ['locale/'] locale_dirs = ['locale/']
# openstackdocstheme options
repository_name = 'openstack/tripleo-puppet-elements'
bug_project = 'tripleo'
bug_tag = 'documentation'

4
test-requirements.txt
View File

@ -1,7 +1,7 @@
openstackdocstheme>=1.11.0 # Apache-2.0
hacking>=0.8.0,<0.9 hacking>=0.8.0,<0.9
oslotest oslotest
oslosphinx sphinx>=1.6.2 # BSD
sphinx>=1.1.2,<1.2
testrepository>=0.0.18 testrepository>=0.0.18
reno>=1.8.0 # Apache-2.0 reno>=1.8.0 # Apache-2.0