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.

This will show other versions of the doc, too.

Change-Id: I2f8e4fec3aa48b91d6ab636504ecc90553a4b802
This commit is contained in:
pengyuesheng 2019-06-28 09:36:58 +08:00
parent 8a1b465ea8
commit 5c1f27f69f
4 changed files with 5 additions and 47 deletions

View File

@ -67,7 +67,6 @@ source_suffix = '.rst'
master_doc = 'index' master_doc = 'index'
# General information about the project. # General information about the project.
project = u'Shared File Systems API Reference'
copyright = u'2010-present, OpenStack Foundation' copyright = u'2010-present, OpenStack Foundation'
# openstackdocstheme options # openstackdocstheme options
@ -75,16 +74,6 @@ repository_name = 'openstack/manila'
bug_project = 'manila' bug_project = 'manila'
bug_tag = 'api-ref' bug_tag = 'api-ref'
# 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 manila.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 # The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages. # for a list of supported languages.
# #
@ -171,11 +160,6 @@ todo_include_todos = False
# directly to the root of the documentation. # directly to the root of the documentation.
# html_extra_path = [] # html_extra_path = []
# If not None, a 'Last updated on:' timestamp is inserted at every page
# bottom, using the given strftime format.
# The empty string is equivalent to '%b %d, %Y'.
html_last_updated_fmt = '%Y-%m-%d %H:%M'
# If true, SmartyPants will be used to convert quotes and dashes to # If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities. # typographically correct entities.
# html_use_smartypants = True # html_use_smartypants = True

View File

@ -1,7 +1,7 @@
# The order of packages is significant, because pip processes them in the order # The order of packages is significant, because pip processes them in the order
# of appearance. Changing the order has an impact on the overall integration # of appearance. Changing the order has an impact on the overall integration
# process, which may cause wedges in the gate later. # process, which may cause wedges in the gate later.
openstackdocstheme>=1.18.1 # Apache-2.0 openstackdocstheme>=1.20.0 # Apache-2.0
reno>=2.5.0 # Apache-2.0 reno>=2.5.0 # Apache-2.0
doc8>=0.6.0 # Apache-2.0 doc8>=0.6.0 # Apache-2.0
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

View File

@ -25,9 +25,8 @@
import eventlet import eventlet
import sys import sys
import os import os
import warnings
import openstackdocstheme import warnings
# NOTE(dims): monkey patch subprocess to prevent failures in latest eventlet # NOTE(dims): monkey patch subprocess to prevent failures in latest eventlet
# See https://github.com/eventlet/eventlet/issues/398 # See https://github.com/eventlet/eventlet/issues/398
@ -71,7 +70,6 @@ sample_policy_basename = '_static/manila'
repository_name = 'openstack/manila' repository_name = 'openstack/manila'
bug_project = 'manila' bug_project = 'manila'
bug_tag = 'docs' bug_tag = 'docs'
html_last_updated_fmt = '%Y-%m-%d %H:%M'
todo_include_todos = True todo_include_todos = True
@ -88,20 +86,8 @@ source_suffix = '.rst'
master_doc = 'index' master_doc = 'index'
# General information about the project. # General information about the project.
project = u'manila'
copyright = u'2010-present, Manila contributors' copyright = u'2010-present, Manila contributors'
# 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 manila.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()
# A few variables have to be set for the log-a-bug feature. # A few variables have to be set for the log-a-bug feature.
# gitsha: The SHA checksum of the bug description. Automatically extracted # gitsha: The SHA checksum of the bug description. Automatically extracted
# from git log. # from git log.
@ -179,14 +165,12 @@ man_pages = [
# a list of builtin themes. # a list of builtin themes.
html_theme = 'openstackdocs' html_theme = 'openstackdocs'
# Add any paths that contain custom themes here, relative to this directory.
html_theme_path = [openstackdocstheme.get_html_theme_path()]
# Theme options are theme-specific and customize the look and feel of a theme # 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 # further. For a list of options available for each theme, see the
# documentation. # documentation.
html_theme_options = {} html_theme_options = {
"show_other_versions": "True",
}
# The name for this set of Sphinx documents. If None, it defaults to # The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation". # "<project> v<release> documentation".

View File

@ -30,8 +30,6 @@
# -- General configuration ------------------------------------------------ # -- General configuration ------------------------------------------------
import openstackdocstheme
# If your documentation needs a minimal Sphinx version, state it here. # If your documentation needs a minimal Sphinx version, state it here.
# needs_sphinx = '1.0' # needs_sphinx = '1.0'
@ -47,7 +45,6 @@ extensions = [
repository_name = 'openstack/manila' repository_name = 'openstack/manila'
bug_project = 'manila' bug_project = 'manila'
bug_tag = 'release notes' bug_tag = 'release notes'
html_last_updated_fmt = '%Y-%m-%d %H:%M'
# Add any paths that contain templates here, relative to this directory. # Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates'] templates_path = ['_templates']
@ -62,15 +59,8 @@ source_suffix = '.rst'
master_doc = 'index' master_doc = 'index'
# General information about the project. # General information about the project.
project = u'Manila Release Notes'
copyright = u'2015, Manila Developers' copyright = u'2015, Manila Developers'
# Release notes are version independent.
# The short X.Y version.
version = ''
# The full version, including alpha/beta/rc tags.
release = ''
# The language for content autogenerated by Sphinx. Refer to documentation # The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages. # for a list of supported languages.
# language = None # language = None