Merge "Docs: switch to openstackdocstheme"

This commit is contained in:
Jenkins 2017-07-24 17:44:38 +00:00 committed by Gerrit Code Review
commit ee17a4cd9a
3 changed files with 19 additions and 11 deletions

View File

@ -63,8 +63,8 @@ gen_ref("v2", "Version 2 API", ["client"])
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = [ extensions = [
'sphinx.ext.autodoc', 'sphinx.ext.autodoc',
'openstackdocstheme',
#'sphinx.ext.intersphinx', #'sphinx.ext.intersphinx',
'oslosphinx'
] ]
# autodoc generation is a bit aggressive and a nuisance when doing heavy # autodoc generation is a bit aggressive and a nuisance when doing heavy
@ -77,7 +77,10 @@ source_suffix = '.rst'
# The master toctree document. # The master toctree document.
master_doc = 'index' master_doc = 'index'
# General information about the project. # openstackdocstheme options
repository_name = 'openstack/python-aodhclient'
bug_project = 'python-aodhclient'
bug_tag = ''
project = u'aodhclient' project = u'aodhclient'
copyright = u'2015, OpenStack Foundation' copyright = u'2015, OpenStack Foundation'
@ -98,6 +101,11 @@ pygments_style = 'sphinx'
# html_theme_path = ["."] # html_theme_path = ["."]
# html_theme = '_theme' # html_theme = '_theme'
# html_static_path = ['static'] # html_static_path = ['static']
html_theme = 'openstackdocs'
html_last_updated_fmt = '%Y-%m-%d %H:%M'
# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = ['_theme']
# Output file base name for HTML help builder. # Output file base name for HTML help builder.
htmlhelp_basename = '%sdoc' % project htmlhelp_basename = '%sdoc' % project

View File

@ -12,9 +12,6 @@
# See the License for the specific language governing permissions and # See the License for the specific language governing permissions and
# limitations under the License. # limitations under the License.
# #
# Aodh Client Release Notes documentation build configuration file, created by
# sphinx-quickstart on Mon Nov 23 20:38:38 2015.
#
# This file is execfile()d with the current directory set to its # This file is execfile()d with the current directory set to its
# containing dir. # containing dir.
# #
@ -38,7 +35,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',
] ]
@ -54,7 +51,10 @@ source_suffix = '.rst'
# The master toctree document. # The master toctree document.
master_doc = 'index' master_doc = 'index'
# General information about the project. # openstackdocstheme options
repository_name = 'openstack/python-aodhclient'
bug_project = 'python-aodhclient'
bug_tag = ''
project = u'Aodh Client Release Notes' project = u'Aodh Client Release Notes'
copyright = u'2015-present, Aodh developers' copyright = u'2015-present, Aodh developers'
@ -112,7 +112,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
@ -150,7 +150,7 @@ html_static_path = ['_static']
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format. # 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 # If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities. # typographically correct entities.

View File

@ -35,8 +35,8 @@ test =
gnocchi[postgresql,file] gnocchi[postgresql,file]
mock>=1.2 # BSD mock>=1.2 # BSD
doc = doc =
sphinx!=1.2.0,!=1.3b1,!=1.6.1,>=1.1.2 sphinx>=1.6.2 # BSD
oslosphinx>=2.5.0 # Apache-2.0 openstackdocstheme>=1.11.0 # Apache-2.0
[entry_points] [entry_points]
console_scripts = console_scripts =