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: I1331abaf1c99a4631ccde3e9fbb70085ca3dcd4e
changes/68/671668/1
pengyuesheng 2 years ago
parent
commit
37958efd1b
4 changed files with 4 additions and 48 deletions
  1. +0
    -16
      api-ref/source/conf.py
  2. +1
    -1
      doc/requirements.txt
  3. +3
    -8
      doc/source/conf.py
  4. +0
    -23
      releasenotes/source/conf.py

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

@ -59,19 +59,8 @@ source_suffix = '.rst'
master_doc = 'index'
# General information about the project.
project = u'Function Engine 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 qinling.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()
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
@ -148,11 +137,6 @@ bug_tag = 'api-ref'
# 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'
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


+ 1
- 1
doc/requirements.txt View File

@ -5,6 +5,6 @@
sphinx>=1.6.2,<2.0.0;python_version=='2.7' # BSD
sphinx>=1.6.2;python_version>='3.4' # BSD
sphinxcontrib-apidoc>=0.2.0 # BSD
openstackdocstheme>=1.11.0 # Apache-2.0
openstackdocstheme>=1.20.0 # Apache-2.0
reno>=1.8.0 # Apache-2.0
os-api-ref>=1.0.0 # Apache-2.0

+ 3
- 8
doc/source/conf.py View File

@ -23,7 +23,6 @@ sys.path.insert(0, os.path.abspath('../..'))
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = [
'sphinx.ext.autodoc',
#'sphinx.ext.intersphinx',
'openstackdocstheme',
]
@ -38,7 +37,6 @@ source_suffix = '.rst'
master_doc = 'index'
# General information about the project.
project = u'Qinling'
copyright = u"%d, OpenStack Foundation" % dt.datetime.now().year
# If true, '()' will be appended to :func: etc. cross-reference text.
@ -60,15 +58,15 @@ html_theme = "openstackdocs"
html_static_path = []
# Output file base name for HTML help builder.
htmlhelp_basename = '%sdoc' % project
htmlhelp_basename = 'Qinlingdoc'
# 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,
u'%s Documentation' % project,
'Qinling.tex',
u'Qinling Documentation',
u'OpenStack Foundation', 'manual'),
]
@ -78,6 +76,3 @@ latex_documents = [
# openstackdocstheme options
repository_name = 'openstack/qinling'
use_storyboard = True
# Must set this variable to include year, month, day, hours, and minutes.
html_last_updated_fmt = '%Y-%m-%d %H:%M'

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

@ -46,7 +46,6 @@ extensions = [
repository_name = 'openstack/qinling'
bug_project = 'qinling'
bug_tag = 'release notes'
html_last_updated_fmt = '%Y-%m-%d %H:%M'
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
@ -61,19 +60,8 @@ source_suffix = '.rst'
master_doc = 'index'
# General information about the project.
project = u'qinling Release Notes'
copyright = u'2016, 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 short X.Y version.
# The full version, including alpha/beta/rc tags.
release = ''
# The short X.Y version.
version = ''
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
# language = None
@ -200,17 +188,6 @@ htmlhelp_basename = 'QinlingReleaseNotesdoc'
# -- 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