summaryrefslogtreecommitdiff
path: root/doc/source
diff options
context:
space:
mode:
authorZuul <zuul@review.openstack.org>2018-10-23 10:23:04 +0000
committerGerrit Code Review <review@openstack.org>2018-10-23 10:23:04 +0000
commit7b6e2e49e3e6dea601dc5bd789ab07e0cea507cd (patch)
treedb92fdab8d643975c48b061f6f4beac42d93814e /doc/source
parent92b4080654b9ecb68250905e45eec65f41e5b161 (diff)
parentad0d99c812e2482387c056937d2678a52c339353 (diff)
downloadoslo-messaging-7b6e2e49e3e6dea601dc5bd789ab07e0cea507cd.tar.gz
Merge "doc: Remove crud from conf.py file"
Diffstat (limited to 'doc/source')
-rw-r--r--doc/source/conf.py60
1 files changed, 11 insertions, 49 deletions
diff --git a/doc/source/conf.py b/doc/source/conf.py
index 06333ce..c4f8700 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -1,24 +1,22 @@
# -*- coding: utf-8 -*-
-
-# Copyright 2017 OpenStack Foundation.
-# All Rights Reserved.
-#
-# Licensed under the Apache License, Version 2.0 (the "License"); you may
-# not use this file except in compliance with the License. You may obtain
-# a copy of the License at
#
-# http://www.apache.org/licenses/LICENSE-2.0
+# Configuration file for the Sphinx documentation builder.
#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
-# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
-# License for the specific language governing permissions and limitations
-# under the License.
+# This file does only contain a selection of the most common options. For a
+# full list see the documentation:
+# http://www.sphinx-doc.org/en/master/config
import os
import sys
sys.path.insert(0, os.path.abspath('../..'))
+
+# -- Project information ------------------------------------------------------
+
+# General information about the project.
+project = 'oslo.messaging'
+copyright = '2018, Oslo Contributors'
+
# -- General configuration ----------------------------------------------------
# Add any Sphinx extension module names here, as strings. They can be
@@ -38,30 +36,9 @@ bug_tag = ''
# Must set this variable to include year, month, day, hours, and minutes.
html_last_updated_fmt = '%Y-%m-%d %H:%M'
-# autodoc generation is a bit aggressive and a nuisance when doing heavy
-# text edit cycles.
-# execute "export SPHINX_DEBUG=1" in your terminal to disable
-
-# Add any paths that contain templates here, relative to this directory.
-# templates_path = []
-
-# The suffix of source filenames.
-source_suffix = '.rst'
-
# The master toctree document.
master_doc = 'index'
-# General information about the project.
-project = u'oslo.messaging'
-copyright = u'2013, OpenStack Foundation'
-
-# 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
-
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
@@ -69,19 +46,4 @@ pygments_style = 'sphinx'
# 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 = 'openstackdocs'
-# html_static_path = ['static']
-
-# Output file base name for HTML help builder.
-htmlhelp_basename = '%sdoc' % project
-
-# Grouping the document tree into LaTeX files. List of tuples
-# (source start file, target name, title, author, documentclass
-# [howto/manual]).
-latex_documents = [
- ('index',
- '%s.tex' % project,
- '%s Documentation' % project,
- 'OpenStack Foundation', 'manual'),
-]