Merge "Remove unicode literal from documentation configuration file and little optimization"

This commit is contained in:
Zuul
2025-08-19 04:19:05 +00:00
committed by Gerrit Code Review

View File

@@ -48,8 +48,13 @@ source_suffix = '.rst'
master_doc = 'index' master_doc = 'index'
# General information about the project. # General information about the project.
project = u'Stackalytics' author = 'Mirantis Inc.'
copyright = u'2013, Mirantis Inc.' target_name = 'stackalytics'
project = 'Stackalytics'
title = 'Stackalytics'
copyright = '2013, Mirantis Inc.'
category = 'Miscellaneous'
description = 'Stackalytics'
# The version info for the project you're documenting, acts as replacement for # The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the # |version| and |release|, also used in various other places throughout the
@@ -100,7 +105,6 @@ 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_path = ['.']
html_theme = '_theme' html_theme = '_theme'
# 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
@@ -109,11 +113,11 @@ html_theme = '_theme'
#html_theme_options = {} #html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory. # Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = [] html_theme_path = ['.']
# The name for this set of Sphinx documents. If None, it defaults to # The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation". # "<project> v<release> documentation".
html_title = 'Stackalytics' # html_title = None
# A shorter title for the navigation bar. Default is the same as html_title. # A shorter title for the navigation bar. Default is the same as html_title.
#html_short_title = None #html_short_title = None
@@ -200,8 +204,8 @@ latex_elements = {
# Grouping the document tree into LaTeX files. List of tuples # Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]). # (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [ latex_documents = [
('index', 'stackalyticsdoc.tex', u'Stackalytics', (master_doc, 'stackalyticsdoc.tex' + target_name + '.tex',
u'Mirantis Inc.', 'manual'), title, author, 'manual'),
] ]
# The name of an image file (relative to this directory) to place at the top of # The name of an image file (relative to this directory) to place at the top of
@@ -230,8 +234,8 @@ latex_documents = [
# One entry per manual page. List of tuples # One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section). # (source start file, name, description, authors, manual section).
man_pages = [ man_pages = [
('index', 'stackalytics', u'Stackalytics', (master_doc, target_name,
[u'Mirantis Inc.'], 1) title, [author], 1)
] ]
# If true, show URL addresses after external links. # If true, show URL addresses after external links.
@@ -244,9 +248,9 @@ man_pages = [
# (source start file, target name, title, author, # (source start file, target name, title, author,
# dir menu entry, description, category) # dir menu entry, description, category)
texinfo_documents = [ texinfo_documents = [
('index', 'Stackalytics', u'Stackalytics', (master_doc, target_name,
u'Mirantis Inc.', 'Stackalytics', 'Stackalytics', title, author, project,
'Miscellaneous'), description, category),
] ]
# Documents to append as an appendix to all manuals. # Documents to append as an appendix to all manuals.