opendev/git-review
Code Issues Proposed changes

Switch to default Sphinx theme

Browse Source 
Since we're publishing documentation to docs.opendev.org now, drop
the openstackdocstheme extension and just use the default Alabaster
theme instead. Also clean up references to OpenStack in the Sphinx
configuration and remove a really old (and unnecessary) copyright
year.

Change-Id: I535783db9dccd36a094d41e6cf08469b6d8c3894
This commit is contained in:
Jeremy Stanley 2021-02-26 18:15:43 +00:00
parent 6db286013f
commit d3afb8039f
2 changed files with 12 additions and 49 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/requirements.txt
View File

@ -1,3 +1,2 @@
sphinx!=1.6.6,!=1.6.7 # BSD sphinx!=1.6.6,!=1.6.7 # BSD
openstackdocstheme>=1.11.0 # Apache-2.0
reno>=2.8.0 # Apache-2.0 reno>=2.8.0 # Apache-2.0

60
doc/source/conf.py
View File

@ -12,8 +12,8 @@
# All configuration values have a default; values that are commented out # All configuration values have a default; values that are commented out
# serve to show the default. # serve to show the default.
import sys
import os import os
import sys
# If extensions (or modules to document with autodoc) are in another directory, # 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 # add these directories to sys.path here. If the directory is relative to the
@ -28,11 +28,7 @@ import os
# Add any Sphinx extension module names here, as strings. They can be # Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones. # ones.
extensions = [ extensions = ['reno.sphinxext']
'sphinx.ext.autodoc',
'openstackdocstheme',
'reno.sphinxext',
]
# Add any paths that contain templates here, relative to this directory. # Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates'] templates_path = ['_templates']
@ -48,7 +44,7 @@ master_doc = 'index'
# General information about the project. # General information about the project.
project = u'git-review' project = u'git-review'
copyright = u'2014, OpenStack Contributors' copyright = u'OpenDev Contributors'
# The language for content autogenerated by Sphinx. Refer to documentation # The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages. # for a list of supported languages.
@ -93,7 +89,9 @@ 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 = 'openstackdocs' # html_theme_path = ["."]
# html_theme = '_theme'
# html_static_path = ['static']
# 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
@ -171,28 +169,16 @@ html_theme = 'openstackdocs'
#html_file_suffix = None #html_file_suffix = None
# Output file base name for HTML help builder. # Output file base name for HTML help builder.
htmlhelp_basename = 'git-reviewdoc' htmlhelp_basename = '%sdoc' % project
# -- Options for LaTeX output ---------------------------------------------
latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt').
#'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
#'preamble': '',
}
# 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, # (source start file, target name, title,
# author, documentclass [howto, manual, or own class]). # author, documentclass [howto, manual, or own class]).
latex_documents = [ latex_documents = [
('index', 'git-review.tex', u'git-review Documentation', ('index',
u'OpenStack Contributors', 'manual'), '%s.tex' % project,
u'%s Documentation' % project,
u'OpenDev Contributors', '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
@ -222,32 +208,10 @@ latex_documents = [
# (source start file, name, description, authors, manual section). # (source start file, name, description, authors, manual section).
man_pages = [ man_pages = [
('index', 'git-review', u'git-review Documentation', ('index', 'git-review', u'git-review Documentation',
[u'OpenStack Contributors'], 1) [u'OpenDev Contributors'], 1)
] ]
# If true, show URL addresses after external links. # If true, show URL addresses after external links.
#man_show_urls = False #man_show_urls = False
# -- Options for Texinfo output -------------------------------------------
# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
('index', 'git-review', u'git-review Documentation',
u'OpenStack Contributors', 'git-review', 'One line description of project.',
'Miscellaneous'),
]
# Documents to append as an appendix to all manuals.
#texinfo_appendices = []
# If false, no module index is generated.
#texinfo_domain_indices = True
# How to display URL addresses: 'footnote', 'no', or 'inline'.
#texinfo_show_urls = 'footnote'
# If true, do not generate a @detailmenu in the "Top" node's menu.
#texinfo_no_detailmenu = False