Browse Source

Bump the openstackdocstheme extension to 1.20

Some options are now automatically configured by the version 1.20:
- project
- html_last_updated_fmt
- latex_engine
- latex_elements
- version
- release.

Change-Id: I432ae5415b9ab8ca7247fb5fb2a8b6e1819029ba
changes/68/673968/3
pengyuesheng 4 months ago
parent
commit
9523029e02
4 changed files with 1 additions and 52 deletions
  1. +0
    -21
      api-ref/source/conf.py
  2. +1
    -1
      doc/requirements.txt
  3. +0
    -14
      doc/source/conf.py
  4. +0
    -16
      releasenotes/source/conf.py

+ 0
- 21
api-ref/source/conf.py View File

@@ -23,11 +23,8 @@
# serve to show the default.

import os
import subprocess
import sys

from senlin.version import version_info

extensions = [
'os_api_ref',
'openstackdocstheme',
@@ -61,18 +58,8 @@ source_suffix = '.rst'
master_doc = 'index'

# General information about the project.
project = u'Clustering API Reference'
copyright = u'2015-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.
#
# 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/senlin'
bug_project = 'senlin'
@@ -149,14 +136,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"]
html_last_updated_fmt = subprocess.check_output(
git_cmd).decode('utf-8')

# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
# html_use_smartypants = True

+ 1
- 1
doc/requirements.txt View File

@@ -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.
# this is required for the docs build jobs
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,>=1.6.5,<2.0.0;python_version=='2.7' # BSD
sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=1.6.5;python_version>='3.4' # BSD

+ 0
- 14
doc/source/conf.py View File

@@ -68,18 +68,6 @@ master_doc = 'index'
project = u'senlin'
copyright = u'2015, 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
#
# "version" and "release" are used by the "log-a-bug" feature
#
# The short X.Y version.
# The full version, including alpha/beta/rc tags.
release = senlin_version.version_string_with_vcs()
# The short X.Y version.
version = senlin_version.canonical_version_string()

# If true, '()' will be appended to :func: etc. cross-reference text.
add_function_parentheses = True

@@ -104,8 +92,6 @@ html_theme = 'openstackdocs'
# Output file base name for HTML help builder.
htmlhelp_basename = '%sdoc' % project

html_last_updated_fmt = '%Y-%m-%d %H:%M'

# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass
# [howto/manual]).

+ 0
- 16
releasenotes/source/conf.py View File

@@ -59,7 +59,6 @@ source_suffix = '.rst'
master_doc = 'index'

# General information about the project.
project = u'Senlin Release Notes'
copyright = u'2015, Senlin Developers'

# Release notes are version independent.
@@ -149,10 +148,6 @@ html_theme = 'openstackdocs'
# 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
@@ -195,17 +190,6 @@ htmlhelp_basename = 'SenlinReleaseNotesdoc'

# -- 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]).

Loading…
Cancel
Save