From 54a2231f175fc6b484e7cbaae8e7ea87778242f8 Mon Sep 17 00:00:00 2001 From: Stephen Finucane Date: Wed, 16 Sep 2020 17:18:59 +0100 Subject: [PATCH] docs: Remove cruft from 'conf.py' Change-Id: Ie44453b647ce78a26246b8293794ebdec68fd120 Signed-off-by: Stephen Finucane --- doc/source/conf.py | 142 ++++----------------------------------------- 1 file changed, 11 insertions(+), 131 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index d9efb139af..06825e9649 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -1,4 +1,3 @@ -# -*- coding: utf-8 -*- # Copyright (c) 2010 OpenStack Foundation. # # Licensed under the Apache License, Version 2.0 (the "License"); @@ -14,18 +13,7 @@ # See the License for the specific language governing permissions and # limitations under the License. -# -# Glance documentation build configuration file, created by -# sphinx-quickstart on Tue May 18 13:50:15 2010. -# -# 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. +# Glance documentation build configuration file import os import sys @@ -33,22 +21,21 @@ import sys # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. -sys.path = [ - os.path.abspath('../..'), - os.path.abspath('../../bin') - ] + sys.path +sys.path.insert(0, os.path.abspath('../..')) +sys.path.insert(0, os.path.abspath('../../bin')) # -- General configuration --------------------------------------------------- # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. -extensions = ['stevedore.sphinxext', - 'sphinx.ext.viewcode', - 'oslo_config.sphinxext', - 'oslo_config.sphinxconfiggen', - 'openstackdocstheme', - 'sphinxcontrib.apidoc', - ] +extensions = [ + 'stevedore.sphinxext', + 'sphinx.ext.viewcode', + 'oslo_config.sphinxext', + 'oslo_config.sphinxconfiggen', + 'openstackdocstheme', + 'sphinxcontrib.apidoc', +] # openstackdocstheme options openstackdocs_repo_name = 'openstack/glance' @@ -78,38 +65,12 @@ config_generator_config_file = [ '_static/glance-scrubber'), ] - -# Add any paths that contain templates here, relative to this directory. -# templates_path = [] - -# The suffix of source filenames. -source_suffix = '.rst' - -# The encoding of source files. -#source_encoding = 'utf-8' - # The master toctree document. master_doc = 'index' # General information about the project. copyright = u'2010-present, OpenStack Foundation.' -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -#language = None - -# There are two options for replacing |today|: either, you set today to some -# non-false value, then it is used: -#today = '' -# Else, today_fmt is used as the format for a strftime call. -#today_fmt = '%B %d, %Y' - -# List of documents that shouldn't be included in the build. -#unused_docs = [] - -# List of directories, relative to source directory, that shouldn't be searched -# for source files. -#exclude_trees = ['api'] exclude_patterns = [ # The man directory includes some snippet files that are included # in other documents during the build but that should not be @@ -120,12 +81,6 @@ exclude_patterns = [ 'cli/openstack_options.txt', ] -# The reST default role (for this markup: `text`) to use for all documents. -#default_role = None - -# If true, '()' will be appended to :func: etc. cross-reference text. -#add_function_parentheses = True - # If true, the current module name will be prepended to all description # unit titles (such as .. function::). add_module_names = True @@ -175,46 +130,11 @@ man_pages = [ # html_theme = '_theme' 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 -# documentation. -#html_theme_options = {} - -# Add any paths that contain custom themes here, relative to this directory. -#html_theme_path = ['_theme'] - -# The name for this set of Sphinx documents. If None, it defaults to -# " v documentation". -#html_title = None - -# A shorter title for the navigation bar. Default is the same as html_title. -#html_short_title = None - -# The name of an image file (relative to this directory) to place at the top -# of the sidebar. -#html_logo = None - -# The name of an image file (within the static path) to use as favicon of the -# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 -# pixels large. -#html_favicon = None - # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ['_static'] -# If true, SmartyPants will be used to convert quotes and dashes to -# typographically correct entities. -#html_use_smartypants = True - -# Custom sidebar templates, maps document names to template names. -#html_sidebars = {} - -# Additional templates that should be rendered to pages, maps page names to -# template names. -#html_additional_pages = {} - # Add any paths that contain "extra" files, such as .htaccess or # robots.txt. html_extra_path = ['_extra'] @@ -225,32 +145,9 @@ html_use_modindex = True # If false, no index is generated. html_use_index = True -# If true, the index is split into individual pages for each letter. -#html_split_index = False - -# If true, links to the reST sources are added to the pages. -#html_show_sourcelink = True - -# If true, an OpenSearch description file will be output, and all pages will -# contain a tag referring to it. The value of this option must be the -# base URL from which the finished HTML is served. -#html_use_opensearch = '' - -# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). -#html_file_suffix = '' - -# Output file base name for HTML help builder. -htmlhelp_basename = 'glancedoc' - # -- Options for LaTeX output ------------------------------------------------ -# The paper size ('letter' or 'a4'). -#latex_paper_size = 'letter' - -# The font size ('10pt', '11pt' or '12pt'). -#latex_font_size = '10pt' - # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, # documentclass [howto/manual]). @@ -258,20 +155,3 @@ latex_documents = [ ('index', 'Glance.tex', u'Glance Documentation', u'Glance Team', 'manual'), ] - -# The name of an image file (relative to this directory) to place at the top of -# the title page. -#latex_logo = None - -# For "manual" documents, if this is true, then toplevel headings are parts, -# not chapters. -#latex_use_parts = False - -# Additional stuff for the LaTeX preamble. -#latex_preamble = '' - -# Documents to append as an appendix to all manuals. -#latex_appendices = [] - -# If false, no module index is generated. -#latex_use_modindex = True