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: Ic2c01fbc8fbe768a3d35d4a091576943f42ca64e
changes/84/670984/2
pengyuesheng 2 years ago
committed by Adam Harwell
parent
commit
7cead0c583
3 changed files with 4 additions and 32 deletions
  1. +1
    -1
      doc/requirements.txt
  2. +3
    -5
      doc/source/conf.py
  3. +0
    -26
      releasenotes/source/conf.py

+ 1
- 1
doc/requirements.txt View File

@ -4,5 +4,5 @@
sphinx>=1.6.2,!=1.6.6,!=1.6.7,<2.0.0;python_version=='2.7' # BSD
sphinx>=1.6.2,!=1.6.6,!=1.6.7,!=2.1.0;python_version>='3.4' # BSD
openstackdocstheme>=1.18.1 # Apache-2.0
openstackdocstheme>=1.20.0 # Apache-2.0
reno>=2.5.0 # Apache-2.0

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

@ -37,7 +37,6 @@ source_suffix = '.rst'
master_doc = 'index'
# General information about the project.
project = u'python-octaviaclient'
copyright = u'2016, OpenStack Foundation'
# If true, '()' will be appended to :func: etc. cross-reference text.
@ -65,15 +64,15 @@ html_theme_options = {
}
# Output file base name for HTML help builder.
htmlhelp_basename = '%sdoc' % project
htmlhelp_basename = 'python-octaviaclientdoc'
# 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,
'python-octaviaclient.tex',
u'python-octaviaclient Documentation',
u'OpenStack Foundation', 'manual'),
]
@ -84,6 +83,5 @@ latex_documents = [
repository_name = 'openstack/python-octaviaclient'
bug_project = '911'
bug_tag = 'doc'
html_last_updated_fmt = '%Y-%m-%d %H:%M'
autoprogram_cliff_application = 'openstack'

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

@ -60,19 +60,8 @@ source_suffix = '.rst'
master_doc = 'index'
# General information about the project.
project = u'octaviaclient 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
@ -152,10 +141,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
@ -199,17 +184,6 @@ htmlhelp_basename = 'PythonOctaviaClientReleaseNotesdoc'
# -- 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,
# documentclass [howto, manual, or own class]).


Loading…
Cancel
Save