openstack/openstacksdk
Code Issues Proposed changes

Cleanup doc/source/conf.py

Browse Source 
Remove old options that are part of openstackdocstheme default settings
since at least version 1.20.

Change-Id: I53d7d6267064f176a43a9cee51a0ee2b964e4a5c
This commit is contained in:
Andreas Jaeger
2019-09-04 07:14:11 +02:00
parent 363852f80d
commit d9b0159f51
2 changed files with 2 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
doc/requirements.txt
View File

@@ -4,7 +4,7 @@
sphinx!=1.6.6,!=1.6.7,>=1.6.2,<2.0.0;python_version=='2.7' # BSD sphinx!=1.6.6,!=1.6.7,>=1.6.2,<2.0.0;python_version=='2.7' # BSD
sphinx!=1.6.6,!=1.6.7,>=1.6.2;python_version>='3.4' # BSD sphinx!=1.6.6,!=1.6.7,>=1.6.2;python_version>='3.4' # BSD
docutils>=0.11 # OSI-Approved Open Source, Public Domain docutils>=0.11 # OSI-Approved Open Source, Public Domain
openstackdocstheme>=1.18.1 # Apache-2.0 openstackdocstheme>=1.20.0 # Apache-2.0
beautifulsoup4>=4.6.0 # MIT beautifulsoup4>=4.6.0 # MIT
reno>=2.5.0 # Apache-2.0 reno>=2.5.0 # Apache-2.0
sphinxcontrib-svg2pdfconverter>=0.1.0 # BSD sphinxcontrib-svg2pdfconverter>=0.1.0 # BSD

26
doc/source/conf.py
View File

@@ -15,8 +15,6 @@ import os
import sys import sys
import warnings import warnings
import openstackdocstheme
sys.path.insert(0, os.path.abspath('../..')) sys.path.insert(0, os.path.abspath('../..'))
sys.path.insert(0, os.path.abspath('.')) sys.path.insert(0, os.path.abspath('.'))
@@ -35,7 +33,6 @@ extensions = [
repository_name = 'openstack/openstacksdk' repository_name = 'openstack/openstacksdk'
bug_project = '972' bug_project = '972'
bug_tag = '' bug_tag = ''
html_last_updated_fmt = '%Y-%m-%d %H:%M'
html_theme = 'openstackdocs' html_theme = 'openstackdocs'
# TODO(shade) Set this to true once the build-openstack-sphinx-docs job is # TODO(shade) Set this to true once the build-openstack-sphinx-docs job is
@@ -57,29 +54,8 @@ source_suffix = '.rst'
master_doc = 'index' master_doc = 'index'
# General information about the project. # General information about the project.
project = u'openstacksdk'
copyright = u'2017, Various members of the OpenStack Foundation' copyright = u'2017, Various members of the OpenStack Foundation'
# A few variables have to be set for the log-a-bug feature.
# gitsha: The SHA checksum of the bug description. Extracted from git log.
# bug_tag: Tag for categorizing the bug. Must be set manually.
# bug_project: Launchpad project to file bugs against.
# These variables are passed to the logabug code via html_context.
git_cmd = "/usr/bin/git log | head -n1 | cut -f2 -d' '"
try:
gitsha = os.popen(git_cmd).read().strip('\n')
except Exception:
warnings.warn("Can not get git sha.")
gitsha = "unknown"
bug_tag = "docs"
pwd = os.getcwd()
# html_context allows us to pass arbitrary values into the html template
html_context = {"pwd": pwd,
"gitsha": gitsha,
"bug_tag": bug_tag,
"bug_project": bug_project}
# If true, '()' will be appended to :func: etc. cross-reference text. # If true, '()' will be appended to :func: etc. cross-reference text.
add_function_parentheses = True add_function_parentheses = True
@@ -101,7 +77,7 @@ exclude_patterns = []
theme_include_auto_toc = False theme_include_auto_toc = False
# Output file base name for HTML help builder. # Output file base name for HTML help builder.
htmlhelp_basename = '%sdoc' % project htmlhelp_basename = 'openstacksdkdoc'
# 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 # (source start file, target name, title, author, documentclass