Switch to openstackdocstheme

As part of docs-migration, use the openstackdocstheme everywhere.
Update requirements for this.

Remove some obsolete comments.

Change-Id: Id1889b0f119ae78ad3b67084c8afcf0c5fa9ece0
This commit is contained in:
Andreas Jaeger 2017-06-30 08:28:57 +02:00
parent afabe8e5c9
commit 4befd3d584
3 changed files with 17 additions and 24 deletions

View File

@ -1,13 +1,5 @@
# -*- coding: utf-8 -*-
#
# Tempest documentation build configuration file, created by
# sphinx-quickstart on Tue May 21 17:43:32 2013.
#
# This file is execfile()d with the current directory set to its containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.
@ -32,13 +24,13 @@ from jinja2.utils import Markup
extensions = ['sphinx.ext.autodoc',
'sphinx.ext.todo',
'sphinx.ext.viewcode',
'oslosphinx'
'openstackdocstheme'
]
todo_include_todos = True
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# templates_path = ['_templates']
# The suffix of source filenames.
source_suffix = '.rst'
@ -51,12 +43,12 @@ master_doc = 'index'
# General information about the project.
project = u'OpenStack Project Infrastructure Manual'
copyright = Markup(u'%s, OpenStack Contributors. Freely licensed under <a '
u'href="http://creativecommons.org/licenses/by/3.0/'
u'legalcode">CC BY 3.0</a>. Propose changes to the <a '
u'href="https://git.openstack.org/cgit/openstack-infra/'
u'infra-manual">infra-manual git repo</a>'
% datetime.date.today().year)
copyright = ('%d, OpenStack Contributors.' % datetime.date.today().year)
# openstackdocstheme options
repository_name = 'openstack-infra/infra-manual'
bug_project = '721'
bug_tag = ''
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
@ -99,7 +91,7 @@ man_pages = []
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
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
@ -125,10 +117,8 @@ html_theme = 'nature'
# pixels large.
#html_favicon = None
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
git_cmd = "git log --pretty=format:'%ad, commit %h' --date=local -n1"
html_last_updated_fmt = os.popen(git_cmd).read()
# Must set this variable to include year, month, day, hours, and minutes.
html_last_updated_fmt = '%Y-%m-%d %H:%M'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.

View File

@ -37,3 +37,6 @@ instead a user or developer looking for API documentation, see
creators
sandbox
testing
Propose changes to this document to the `infra-manual git repository
<https://git.openstack.org/cgit/openstack-infra/infra-manual>`_.

View File

@ -1,6 +1,6 @@
# The order of packages is significant, because pip processes them in the order
# of appearance. Changing the order has an impact on the overall integration
# process, which may cause wedges in the gate later.
pbr>=1.6 # Apache-2.0
oslosphinx
sphinx!=1.3b1,<1.4,>=1.2.1 # BSD
pbr>=2.0.0,!=2.1.0 # Apache-2.0
openstackdocstheme>=1.11.0 # Apache-2.0
sphinx>=1.6.2 # BSD