From 7987022035ed427fa747c526459ba2f13554338a Mon Sep 17 00:00:00 2001 From: Stephen Finucane Date: Wed, 14 May 2025 14:37:45 +0100 Subject: [PATCH] api-ref: Remove crud from conf.py Change-Id: Id3cd992c6bc5fb4eac65c139963fec55bba04c1f Signed-off-by: Stephen Finucane --- api-ref/source/conf.py | 152 +++++------------------------------------ 1 file changed, 17 insertions(+), 135 deletions(-) diff --git a/api-ref/source/conf.py b/api-ref/source/conf.py index b92c35b9b..7dea2b702 100644 --- a/api-ref/source/conf.py +++ b/api-ref/source/conf.py @@ -25,16 +25,6 @@ import os import sys -extensions = [ - 'os_api_ref', - 'openstackdocstheme', -] - -html_theme = 'openstackdocs' -html_theme_options = { - "sidebar_mode": "toc", -} - # 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. @@ -46,14 +36,14 @@ sys.path.insert(0, os.path.abspath('./')) # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. +extensions = [ + 'os_api_ref', + 'openstackdocstheme', +] # The suffix of source filenames. source_suffix = '.rst' -# The encoding of source files. -# -# source_encoding = 'utf-8' - # The master toctree document. master_doc = 'index' @@ -61,34 +51,9 @@ master_doc = 'index' project = 'Networking API Reference' copyright = '2010-present, OpenStack Foundation' -# openstackdocstheme options -openstackdocs_repo_name = 'openstack/neutron-lib' -openstackdocs_bug_project = 'neutron' -openstackdocs_bug_tag = 'api-ref' -openstackdocs_auto_name = False - release = '' -# The short X.Y version. version = '' -# 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' - -# The reST default role (used 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 = False @@ -100,91 +65,15 @@ show_authors = False # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'native' -# -- Options for man page output ---------------------------------------------- - -# Grouping the document tree for man pages. -# List of tuples 'sourcefile', 'target', u'title', u'Authors name', 'manual' - - # -- Options for HTML output -------------------------------------------------- -# The theme to use for HTML and HTML Help pages. Major themes that come with -# Sphinx are currently 'default' and 'sphinxdoc'. -# html_theme_path = ["."] -# html_theme = '_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 -# documentation. -# html_theme_options = {} - -# Add any paths that contain custom themes here, relative to this directory. -# html_theme_path = [] - -# 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 = {} - -# If false, no module index is generated. -# 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 = 'neutrondoc' - +html_theme = 'openstackdocs' +html_theme_options = { + 'sidebar_mode': 'toc', +} # -- 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]). @@ -193,22 +82,7 @@ latex_documents = [ 'OpenStack Foundation', '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 +# -- Options for linkcheck builder -------------------------------------------- linkcheck_anchors_ignore = [ # skip gerrit anchors @@ -216,3 +90,11 @@ linkcheck_anchors_ignore = [ 'q\\,.*', '\\/c\\/.*' ] + +# -- Options for openstackdocstheme ------------------------------------------- + +# openstackdocstheme options +openstackdocs_repo_name = 'openstack/neutron-lib' +openstackdocs_bug_project = 'neutron' +openstackdocs_bug_tag = 'api-ref' +openstackdocs_auto_name = False