Bump the openstackdocstheme extension to 1.20.0
Some options are now automatically configured by the version 1.20: - project - html_last_updated_fmt - latex_elements - version - release. The change also fixed Apache Kafka URLs in API and persister configuration in DevStack plugin. Depends-On: https://review.opendev.org/689513 Change-Id: I9f3c611029385eb9d4ff2a2ff190b441b1971f33
This commit is contained in:
parent
64e4e9af47
commit
5e7f9f193d
@ -16,8 +16,6 @@
|
|||||||
# All configuration values have a default; values that are commented out
|
# All configuration values have a default; values that are commented out
|
||||||
# serve to show the default.
|
# serve to show the default.
|
||||||
|
|
||||||
from monasca_events_api.version import version_info
|
|
||||||
|
|
||||||
# -- General configuration ------------------------------------------------
|
# -- General configuration ------------------------------------------------
|
||||||
|
|
||||||
# If your documentation needs a minimal Sphinx version, state it here.
|
# If your documentation needs a minimal Sphinx version, state it here.
|
||||||
@ -45,9 +43,6 @@ master_doc = 'index'
|
|||||||
|
|
||||||
# General details about project
|
# General details about project
|
||||||
repository_name = u'openstack/monasca-events-api'
|
repository_name = u'openstack/monasca-events-api'
|
||||||
project = u'Monitoring Events API Reference'
|
|
||||||
version = version_info.canonical_version_string()
|
|
||||||
release = version_info.version_string_with_vcs()
|
|
||||||
bug_project = u'866'
|
bug_project = u'866'
|
||||||
bug_tag = u''
|
bug_tag = u''
|
||||||
copyright = u'2014-present, OpenStack Foundation'
|
copyright = u'2014-present, OpenStack Foundation'
|
||||||
@ -128,10 +123,6 @@ html_short_title = 'API Ref'
|
|||||||
# directly to the root of the documentation.
|
# directly to the root of the documentation.
|
||||||
# html_extra_path = []
|
# 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
|
# 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
|
||||||
@ -174,17 +165,6 @@ htmlhelp_basename = 'MonitoringEventsApiRefDoc'
|
|||||||
|
|
||||||
# -- Options for LaTeX output ---------------------------------------------
|
# -- 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
|
# Grouping the document tree into LaTeX files. List of tuples
|
||||||
# (source start file, target name, title,
|
# (source start file, target name, title,
|
||||||
# author, documentclass [howto, manual, or own class]).
|
# author, documentclass [howto, manual, or own class]).
|
||||||
|
@ -69,6 +69,9 @@ function configure_events_api {
|
|||||||
|
|
||||||
iniset "$MONASCA_EVENTS_API_CONF" DEFAULT log_config_append $MONASCA_EVENTS_API_LOGGING_CONF
|
iniset "$MONASCA_EVENTS_API_CONF" DEFAULT log_config_append $MONASCA_EVENTS_API_LOGGING_CONF
|
||||||
|
|
||||||
|
# configure events_publisher
|
||||||
|
iniset "$MONASCA_EVENTS_API_CONF" events_publisher kafka_url "$SERVICE_HOST:9092"
|
||||||
|
|
||||||
# configure keystone middleware
|
# configure keystone middleware
|
||||||
configure_auth_token_middleware "$MONASCA_EVENTS_API_CONF" "admin" $MONASCA_EVENTS_API_CACHE_DIR
|
configure_auth_token_middleware "$MONASCA_EVENTS_API_CONF" "admin" $MONASCA_EVENTS_API_CACHE_DIR
|
||||||
iniset "$MONASCA_EVENTS_API_CONF" keystone_authtoken region_name $REGION_NAME
|
iniset "$MONASCA_EVENTS_API_CONF" keystone_authtoken region_name $REGION_NAME
|
||||||
|
@ -49,7 +49,7 @@ function configure_events_persister {
|
|||||||
iniset "$MONASCA_EVENTS_PERSISTER_CONF" kafka num_processors 0
|
iniset "$MONASCA_EVENTS_PERSISTER_CONF" kafka num_processors 0
|
||||||
iniset "$MONASCA_EVENTS_PERSISTER_CONF" kafka_events num_processors 1
|
iniset "$MONASCA_EVENTS_PERSISTER_CONF" kafka_events num_processors 1
|
||||||
iniset "$MONASCA_EVENTS_PERSISTER_CONF" kafka_events enabled True
|
iniset "$MONASCA_EVENTS_PERSISTER_CONF" kafka_events enabled True
|
||||||
iniset "$MONASCA_EVENTS_PERSISTER_CONF" kafka_events uri 127.0.0.1:9092
|
iniset "$MONASCA_EVENTS_PERSISTER_CONF" kafka_events uri $SERVICE_HOST:9092
|
||||||
iniset "$MONASCA_EVENTS_PERSISTER_CONF" elasticsearch hosts ${ELASTICSEARCH_BIND_HOST}:${ELASTICSEARCH_BIND_PORT}
|
iniset "$MONASCA_EVENTS_PERSISTER_CONF" elasticsearch hosts ${ELASTICSEARCH_BIND_HOST}:${ELASTICSEARCH_BIND_PORT}
|
||||||
|
|
||||||
sudo cp -f "${MONASCA_EVENTS_DEVSTACK_DIR}"/files/monasca-events-persister/events-persister-logging.conf \
|
sudo cp -f "${MONASCA_EVENTS_DEVSTACK_DIR}"/files/monasca-events-persister/events-persister-logging.conf \
|
||||||
|
@ -15,8 +15,6 @@
|
|||||||
import os
|
import os
|
||||||
import sys
|
import sys
|
||||||
|
|
||||||
from monasca_events_api.version import version_info
|
|
||||||
|
|
||||||
sys.path = [
|
sys.path = [
|
||||||
os.path.abspath('../..'),
|
os.path.abspath('../..'),
|
||||||
os.path.abspath('../../bin'),
|
os.path.abspath('../../bin'),
|
||||||
@ -46,9 +44,6 @@ extensions = [
|
|||||||
|
|
||||||
# geeneral information about project
|
# geeneral information about project
|
||||||
repository_name = u'openstack/monasca-events-api'
|
repository_name = u'openstack/monasca-events-api'
|
||||||
project = u'monasca'
|
|
||||||
version = version_info.canonical_version_string()
|
|
||||||
release = version_info.version_string_with_vcs()
|
|
||||||
bug_project = u'866'
|
bug_project = u'866'
|
||||||
bug_tag = u''
|
bug_tag = u''
|
||||||
copyright = u'2017-present, OpenStack Foundation'
|
copyright = u'2017-present, OpenStack Foundation'
|
||||||
@ -135,17 +130,13 @@ html_theme = 'openstackdocs'
|
|||||||
# Add any paths that contain custom static files (such as style sheets) here,
|
# Add any paths that contain custom static files (such as style sheets) here,
|
||||||
# relative to this directory. They are copied after the builtin static files,
|
# relative to this directory. They are copied after the builtin static files,
|
||||||
# so a file named "default.css" will overwrite the builtin "default.css".
|
# so a file named "default.css" will overwrite the builtin "default.css".
|
||||||
html_static_path = ['_static']
|
html_static_path = []
|
||||||
|
|
||||||
# Add any extra paths that contain custom files (such as robots.txt or
|
# Add any extra paths that contain custom files (such as robots.txt or
|
||||||
# .htaccess) here, relative to this directory. These files are copied
|
# .htaccess) here, relative to this directory. These files are copied
|
||||||
# directly to the root of the documentation.
|
# directly to the root of the documentation.
|
||||||
# html_extra_path = []
|
# 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
|
# 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
|
||||||
@ -205,20 +196,6 @@ htmlhelp_basename = 'MonitoringEventsApiDoc'
|
|||||||
|
|
||||||
# -- Options for LaTeX output ---------------------------------------------
|
# -- 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': '',
|
|
||||||
|
|
||||||
# Latex figure (float) alignment
|
|
||||||
#'figure_align': 'htbp',
|
|
||||||
}
|
|
||||||
|
|
||||||
# Grouping the document tree into LaTeX files. List of tuples
|
# Grouping the document tree into LaTeX files. List of tuples
|
||||||
# (source start file, target name, title,
|
# (source start file, target name, title,
|
||||||
# author, documentclass [howto, manual, or own class]).
|
# author, documentclass [howto, manual, or own class]).
|
||||||
@ -261,4 +238,4 @@ man_pages = [
|
|||||||
#man_show_urls = False
|
#man_show_urls = False
|
||||||
|
|
||||||
# Example configuration for intersphinx: refer to the Python standard library.
|
# Example configuration for intersphinx: refer to the Python standard library.
|
||||||
intersphinx_mapping = {'https://doc.python.org/': None}
|
intersphinx_mapping = {'https://doc.python.org/': None}
|
||||||
|
@ -7,7 +7,7 @@ fixtures==3.0.0
|
|||||||
keystonemiddleware==4.12.0
|
keystonemiddleware==4.12.0
|
||||||
mock==2.0
|
mock==2.0
|
||||||
monasca-common==1.4.0
|
monasca-common==1.4.0
|
||||||
openstackdocstheme==1.16.0
|
openstackdocstheme==1.20.0
|
||||||
os-api-ref==1.0.0
|
os-api-ref==1.0.0
|
||||||
oslo.config==6.1.0
|
oslo.config==6.1.0
|
||||||
oslo.context==2.14.0
|
oslo.context==2.14.0
|
||||||
|
@ -38,7 +38,6 @@ master_doc = 'index'
|
|||||||
|
|
||||||
# General information about the project.
|
# General information about the project.
|
||||||
repository_name = u'openstack/monasca-events-api'
|
repository_name = u'openstack/monasca-events-api'
|
||||||
project = u'OpenStack Monitoring Release Notes'
|
|
||||||
# Release notes do not need a version number in the title, they
|
# Release notes do not need a version number in the title, they
|
||||||
# cover multiple releases.
|
# cover multiple releases.
|
||||||
version = ''
|
version = ''
|
||||||
@ -127,10 +126,6 @@ html_theme = 'openstackdocs'
|
|||||||
# directly to the root of the documentation.
|
# directly to the root of the documentation.
|
||||||
# html_extra_path = []
|
# 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
|
# 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
|
||||||
@ -173,17 +168,6 @@ htmlhelp_basename = 'MonitoringEventsApiReleaseNotesDoc'
|
|||||||
|
|
||||||
# -- Options for LaTeX output ---------------------------------------------
|
# -- 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
|
# Grouping the document tree into LaTeX files. List of tuples
|
||||||
# (source start file, target name, title,
|
# (source start file, target name, title,
|
||||||
# author, documentclass [howto, manual, or own class]).
|
# author, documentclass [howto, manual, or own class]).
|
||||||
|
@ -22,4 +22,4 @@ 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,!=2.1.0,>=1.6.2;python_version>='3.4' # BSD
|
sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=1.6.2;python_version>='3.4' # BSD
|
||||||
os-api-ref>=1.0.0 # Apache-2.0
|
os-api-ref>=1.0.0 # Apache-2.0
|
||||||
reno>=2.5.0 # Apache-2.0
|
reno>=2.5.0 # Apache-2.0
|
||||||
openstackdocstheme>=1.16.0 # Apache-2.0
|
openstackdocstheme>=1.20.0 # Apache-2.0
|
||||||
|
Loading…
Reference in New Issue
Block a user