Update specs to build with Sphinx 2.0
The oslosphinx theme is EOL and doesn't work with Sphinx 2.0, so we need to switch to openstackdocstheme instead. This patch is following what nova-specs did in [0], but of course all blame is to go on me, not them. [0] https://review.opendev.org/648670 Change-Id: Iaf5bb355dae15ee3681b39d354f160951d19f47f
This commit is contained in:
Jens Harbott
parent
603ade936f
commit
a57a5f190b
|
|
@ -1,16 +1,6 @@
|
|||
# -*- 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.
|
||||
|
||||
import datetime
|
||||
import sys
|
||||
import os
|
||||
|
||||
|
|
@ -26,30 +16,18 @@ import os
|
|||
|
||||
# Add any Sphinx extension module names here, as strings. They can be extensions
|
||||
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
||||
extensions = ['sphinx.ext.autodoc',
|
||||
'sphinx.ext.intersphinx',
|
||||
'sphinx.ext.todo',
|
||||
'sphinx.ext.viewcode',
|
||||
'oslosphinx'
|
||||
extensions = ['sphinx.ext.todo',
|
||||
'openstackdocstheme'
|
||||
]
|
||||
|
||||
todo_include_todos = True
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
templates_path = ['_templates']
|
||||
|
||||
# The suffix of source filenames.
|
||||
source_suffix = '.rst'
|
||||
|
||||
# The encoding of source files.
|
||||
#source_encoding = 'utf-8-sig'
|
||||
|
||||
# The master toctree document.
|
||||
master_doc = 'index'
|
||||
|
||||
# General information about the project.
|
||||
project = u'Chef for OpenStack Specs'
|
||||
copyright = u'2014, Chef for OpenStack Team'
|
||||
project = u'OpenStack Chef Specs'
|
||||
copyright = u'%s, OpenStack Chef Team' % datetime.date.today().year
|
||||
|
||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||
# for a list of supported languages.
|
||||
|
|
@ -86,6 +64,9 @@ pygments_style = 'sphinx'
|
|||
# A list of ignored prefixes for module index sorting.
|
||||
modindex_common_prefix = ['openstack-chef-specs.']
|
||||
|
||||
version = ''
|
||||
release = ''
|
||||
|
||||
# -- Options for man page output ----------------------------------------------
|
||||
man_pages = []
|
||||
|
||||
|
|
@ -93,7 +74,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
|
||||
|
|
@ -181,8 +162,8 @@ latex_elements = {
|
|||
# Grouping the document tree into LaTeX files. List of tuples
|
||||
# (source start file, target name, title, author, documentclass [howto/manual]).
|
||||
latex_documents = [
|
||||
('index', 'OpenStack-Chef-specs.tex', u'Chef for OpenStack Specs',
|
||||
u'Chef for OpenStack Team', 'manual'),
|
||||
('index', 'OpenStack-Chef-specs.tex', u'OpenStack Chef Specs',
|
||||
u'OpenStack Chef Team', 'manual'),
|
||||
]
|
||||
|
||||
# The name of an image file (relative to this directory) to place at the top of
|
||||
|
|
@ -211,9 +192,9 @@ latex_documents = [
|
|||
# (source start file, target name, title, author,
|
||||
# dir menu entry, description, category)
|
||||
texinfo_documents = [
|
||||
('index', 'OpenStack-Chef-specs', u'Chef for OpenStack Design Specs',
|
||||
u'Chef for OpenStack Team', 'openstack-chef-specs',
|
||||
'Design specifications for the Chef for OpenStack project.',
|
||||
('index', 'OpenStack-Chef-specs', u'OpenStack Chef Design Specs',
|
||||
u'OpenStack Chef Team', 'openstack-chef-specs',
|
||||
'Design specifications for the OpenStack Chef project.',
|
||||
'Miscellaneous'),
|
||||
]
|
||||
|
||||
|
|
@ -226,45 +207,3 @@ texinfo_documents = [
|
|||
# How to display URL addresses: 'footnote', 'no', or 'inline'.
|
||||
#texinfo_show_urls = 'footnote'
|
||||
|
||||
|
||||
# -- Options for Epub output ---------------------------------------------------
|
||||
|
||||
# Bibliographic Dublin Core info.
|
||||
epub_title = u'Chef for OpenStack Specs'
|
||||
epub_author = u'Chef for OpenStack Team'
|
||||
epub_publisher = u'Chef for OpenStack Team'
|
||||
epub_copyright = u'2014, Chef for OpenStack Team'
|
||||
|
||||
# The language of the text. It defaults to the language option
|
||||
# or en if the language is not set.
|
||||
#epub_language = ''
|
||||
|
||||
# The scheme of the identifier. Typical schemes are ISBN or URL.
|
||||
#epub_scheme = ''
|
||||
|
||||
# The unique identifier of the text. This can be a ISBN number
|
||||
# or the project homepage.
|
||||
#epub_identifier = ''
|
||||
|
||||
# A unique identification for the text.
|
||||
#epub_uid = ''
|
||||
|
||||
# A tuple containing the cover image and cover page html template filenames.
|
||||
#epub_cover = ()
|
||||
|
||||
# HTML files that should be inserted before the pages created by sphinx.
|
||||
# The format is a list of tuples containing the path and title.
|
||||
#epub_pre_files = []
|
||||
|
||||
# HTML files shat should be inserted after the pages created by sphinx.
|
||||
# The format is a list of tuples containing the path and title.
|
||||
#epub_post_files = []
|
||||
|
||||
# A list of files that should not be packed into the epub file.
|
||||
#epub_exclude_files = []
|
||||
|
||||
# The depth of the table of contents in toc.ncx.
|
||||
#epub_tocdepth = 3
|
||||
|
||||
# Allow duplicate toc entries.
|
||||
#epub_tocdup = True
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
oslosphinx
|
||||
openstackdocstheme>=1.19.0 # Apache-2.0
|
||||
pbr>=0.6
|
||||
sphinx>=1.1.2
|
||||
testrepository>=0.0.18
|
||||
|
|
|
|||
Loading…
Reference in New Issue