summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorZuul <zuul@review.opendev.org>2019-09-25 15:50:37 +0000
committerGerrit Code Review <review@openstack.org>2019-09-25 15:50:37 +0000
commit784863f12abb401cb6e33b9c352281abfd8eb71a (patch)
treee57c34064aa8d2cb2d61ed53c2483654a708df6e
parent14b14dcfc7fbd08757e9c3c6f58a81867558094f (diff)
parent14f2678c48775acdc57f6b65c96b47f5201e73c0 (diff)
downloadheat-784863f12abb401cb6e33b9c352281abfd8eb71a.tar.gz
Merge "Bump the openstackdocstheme extension to 1.20"
-rw-r--r--api-ref/source/conf.py24
-rw-r--r--doc/requirements.txt2
-rw-r--r--doc/source/conf.py26
-rw-r--r--releasenotes/source/conf.py16
4 files changed, 1 insertions, 67 deletions
diff --git a/api-ref/source/conf.py b/api-ref/source/conf.py
index 17886a2f0..511405d58 100644
--- a/api-ref/source/conf.py
+++ b/api-ref/source/conf.py
@@ -26,9 +26,7 @@
# serve to show the default.
import os
-import subprocess
import sys
-import warnings
html_theme = 'openstackdocs'
html_theme_options = {
@@ -63,19 +61,8 @@ source_suffix = '.rst'
master_doc = 'index'
# General information about the project.
-project = u'Orchestration API Reference'
copyright = u'2010-present, OpenStack Foundation'
-# The version info for the project you're documenting, acts as replacement for
-# |version| and |release|, also used in various other places throughout the
-# built documents.
-#
-from heat.version import version_info
-# The full version, including alpha/beta/rc tags.
-release = version_info.release_string()
-# The short X.Y version.
-version = version_info.version_string()
-
# openstackdocstheme options
repository_name = 'openstack/heat'
bug_project = 'heat'
@@ -152,17 +139,6 @@ pygments_style = 'sphinx'
# so a file named "default.css" will overwrite the builtin "default.css".
# html_static_path = ['_static']
-# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
-# using the given strftime format.
-# html_last_updated_fmt = '%b %d, %Y'
-git_cmd = ["git", "log", "--pretty=format:'%ad, commit %h'", "--date=local",
- "-n1"]
-try:
- html_last_updated_fmt = subprocess.check_output(git_cmd).decode('utf-8')
-except Exception:
- warnings.warn('Cannot get last updated time from git repository. '
- 'Not setting "html_last_updated_fmt".')
-
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
# html_use_smartypants = True
diff --git a/doc/requirements.txt b/doc/requirements.txt
index c4373b460..57ca58cd6 100644
--- a/doc/requirements.txt
+++ b/doc/requirements.txt
@@ -2,7 +2,7 @@
# of appearance. Changing the order has an impact on the overall integration
# process, which may cause wedges in the gate later.
-openstackdocstheme>=1.18.1 # Apache-2.0
+openstackdocstheme>=1.20.0 # Apache-2.0
os-api-ref>=1.4.0 # Apache-2.0
sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=1.6.2;python_version>='3.4' # BSD
sphinx!=1.6.6,!=1.6.7,>=1.6.2,<2.0.0;python_version=='2.7' # BSD
diff --git a/doc/source/conf.py b/doc/source/conf.py
index 053241144..1342c5be7 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -26,10 +26,8 @@
import glob
import os
-import subprocess
import sys
import tempfile
-import warnings
from oslo_config import cfg
@@ -115,7 +113,6 @@ source_suffix = '.rst'
master_doc = 'index'
# General information about the project.
-project = u'Heat'
copyright = u'(c) 2012- Heat Developers'
# The language for content autogenerated by Sphinx. Refer to documentation
@@ -183,7 +180,6 @@ apidoc_excluded_paths = [
# html_theme = '_theme'
html_theme = 'openstackdocs'
-html_last_updated_fmt = '%Y-%m-%d %H:%M'
# 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
# documentation.
@@ -217,17 +213,6 @@ html_static_path = ['_static']
# robots.txt.
html_extra_path = ['_extra']
-# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
-# using the given strftime format.
-# html_last_updated_fmt = '%b %d, %Y'
-git_cmd = ["git", "log", "--pretty=format:'%ad, commit %h'", "--date=local",
- "-n1"]
-try:
- html_last_updated_fmt = subprocess.check_output(git_cmd).decode('utf-8')
-except Exception:
- warnings.warn('Cannot get last updated time from git repository. '
- 'Not setting "html_last_updated_fmt".')
-
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
# html_use_smartypants = True
@@ -271,17 +256,6 @@ htmlhelp_basename = 'Heatdoc'
# -- 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
# (source start file, target name, title, author, documentclass [howto/manual])
latex_documents = [
diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py
index d0db3f0d7..1ae00908a 100644
--- a/releasenotes/source/conf.py
+++ b/releasenotes/source/conf.py
@@ -60,7 +60,6 @@ source_suffix = '.rst'
master_doc = 'index'
# General information about the project.
-project = u'Heat Release Notes'
copyright = u'2015, Heat Developers'
# Release notes are version independent, no need to set version and release
@@ -146,10 +145,6 @@ html_static_path = ['_static']
# directly to the root of the documentation.
# html_extra_path = []
-# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
-# using the given strftime format.
-html_last_updated_fmt = '%Y-%m-%d %H:%M'
-
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
# html_use_smartypants = True
@@ -193,17 +188,6 @@ htmlhelp_basename = 'HeatReleaseNotesdoc'
# -- 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
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).