summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorZuul <zuul@review.opendev.org>2021-03-02 17:52:26 +0000
committerGerrit Code Review <review@openstack.org>2021-03-02 17:52:26 +0000
commit560d0a98e02c405b6671b760a71053bf30e3d6b9 (patch)
treead8890966851f77e7f67292f86e511a40e5ba141
parente14c72ab7a4fa88fbdd688281c4476beea00ea9c (diff)
parentd3afb8039f913ee6d7e2d3ba49403dd8e59af9b2 (diff)
downloadgit-review-560d0a98e02c405b6671b760a71053bf30e3d6b9.tar.gz
Merge "Switch to default Sphinx theme"
-rw-r--r--doc/requirements.txt1
-rw-r--r--doc/source/conf.py60
2 files changed, 12 insertions, 49 deletions
diff --git a/doc/requirements.txt b/doc/requirements.txt
index b6c34f4..c579bb4 100644
--- a/doc/requirements.txt
+++ b/doc/requirements.txt
@@ -1,3 +1,2 @@
sphinx!=1.6.6,!=1.6.7 # BSD
-openstackdocstheme>=1.11.0 # Apache-2.0
reno>=2.8.0 # Apache-2.0
diff --git a/doc/source/conf.py b/doc/source/conf.py
index a1ff9ca..39f262c 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -12,8 +12,8 @@
# All configuration values have a default; values that are commented out
# serve to show the default.
-import sys
import os
+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
@@ -28,11 +28,7 @@ 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',
- 'openstackdocstheme',
- 'reno.sphinxext',
-]
+extensions = ['reno.sphinxext']
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
@@ -48,7 +44,7 @@ master_doc = 'index'
# General information about the project.
project = u'git-review'
-copyright = u'2014, OpenStack Contributors'
+copyright = u'OpenDev Contributors'
# The language for content autogenerated by Sphinx. Refer to documentation
# 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
# 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
# further. For a list of options available for each theme, see the
@@ -171,28 +169,16 @@ html_theme = 'openstackdocs'
#html_file_suffix = None
# Output file base name for HTML help builder.
-htmlhelp_basename = 'git-reviewdoc'
-
-
-# -- 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': '',
-}
+htmlhelp_basename = '%sdoc' % project
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
- ('index', 'git-review.tex', u'git-review Documentation',
- u'OpenStack Contributors', 'manual'),
+ ('index',
+ '%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
@@ -222,32 +208,10 @@ latex_documents = [
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'git-review', u'git-review Documentation',
- [u'OpenStack Contributors'], 1)
+ [u'OpenDev Contributors'], 1)
]
# If true, show URL addresses after external links.
#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