Doc cleanups
Switch to newer openstackdocstheme and remove settings that are default now. Change-Id: I27895a6fb91ba3be37831a697098718082eec00f
This commit is contained in:
@@ -23,7 +23,6 @@
|
|||||||
# serve to show the default.
|
# serve to show the default.
|
||||||
|
|
||||||
import os
|
import os
|
||||||
import subprocess
|
|
||||||
import sys
|
import sys
|
||||||
|
|
||||||
html_theme = 'openstackdocs'
|
html_theme = 'openstackdocs'
|
||||||
@@ -62,19 +61,10 @@ master_doc = 'index'
|
|||||||
project = u'Messaging Service API Reference'
|
project = u'Messaging Service API Reference'
|
||||||
copyright = u'2010-present, OpenStack Foundation'
|
copyright = u'2010-present, OpenStack Foundation'
|
||||||
|
|
||||||
# The version info for the project you're documenting, acts as replacement for
|
repository_name = 'openstack/zaqar'
|
||||||
# |version| and |release|, also used in various other places throughout the
|
bug_project = 'zaqar'
|
||||||
# built documents.
|
bug_tag = ''
|
||||||
#
|
|
||||||
from zaqar.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()
|
|
||||||
|
|
||||||
# html_context allows us to pass arbitrary values into the html template
|
|
||||||
html_context = {'bug_tag': 'api-ref',
|
|
||||||
'bug_project': 'zaqar'}
|
|
||||||
|
|
||||||
# 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.
|
||||||
@@ -147,13 +137,6 @@ pygments_style = 'sphinx'
|
|||||||
# 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 = ['_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
|
# 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
|
||||||
|
@@ -140,7 +140,7 @@ function configure_zaqar {
|
|||||||
zaqar-sql-db-manage --config-file $ZAQAR_CONF upgrade head
|
zaqar-sql-db-manage --config-file $ZAQAR_CONF upgrade head
|
||||||
|
|
||||||
iniset $ZAQAR_CONF drivers message_store swift
|
iniset $ZAQAR_CONF drivers message_store swift
|
||||||
iniset $ZAQAR_CONF 'drivers:message_store:swift' auth_url $KEYSTONE_AUTH_URI_V3
|
iniset $ZAQAR_CONF 'drivers:message_store:swift' auth_url $KEYSTONE_AUTH_URI
|
||||||
iniset $ZAQAR_CONF 'drivers:message_store:swift' uri swift://zaqar:$SERVICE_PASSWORD@/service
|
iniset $ZAQAR_CONF 'drivers:message_store:swift' uri swift://zaqar:$SERVICE_PASSWORD@/service
|
||||||
fi
|
fi
|
||||||
|
|
||||||
|
@@ -1,8 +1,8 @@
|
|||||||
# 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.31.2 # Apache-2.0
|
||||||
sphinx!=1.6.6,!=1.6.7,>=1.6.3;python_version>='3.4' # BSD
|
sphinx!=1.6.6,!=1.6.7,>=1.6.3 # BSD
|
||||||
sphinxcontrib-apidoc>=0.2.0 # BSD
|
sphinxcontrib-apidoc>=0.2.0 # BSD
|
||||||
reno>=2.5.0 # Apache-2.0
|
reno>=2.5.0 # Apache-2.0
|
||||||
os-api-ref>=1.4.0 # Apache-2.0
|
os-api-ref>=1.4.0 # Apache-2.0
|
||||||
|
@@ -166,8 +166,7 @@ html_static_path = ['_static']
|
|||||||
|
|
||||||
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
|
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
|
||||||
# using the given strftime format.
|
# using the given strftime format.
|
||||||
#html_last_updated_fmt = '%b %d, %Y'
|
# html_last_updated_fmt = '%Y-%m-%d %H:%M'
|
||||||
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.
|
||||||
|
@@ -18,7 +18,7 @@ keystoneauth1==3.4.0
|
|||||||
keystonemiddleware==4.17.0
|
keystonemiddleware==4.17.0
|
||||||
mock==2.0.0
|
mock==2.0.0
|
||||||
msgpack==0.5.1
|
msgpack==0.5.1
|
||||||
openstackdocstheme==1.18.1
|
openstackdocstheme==1.31.2
|
||||||
os-api-ref==1.4.0
|
os-api-ref==1.4.0
|
||||||
os-client-config==1.28.0
|
os-client-config==1.28.0
|
||||||
os-testr==1.0.0
|
os-testr==1.0.0
|
||||||
|
@@ -142,7 +142,7 @@ html_theme = 'openstackdocs'
|
|||||||
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
|
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
|
||||||
# using the given strftime format.
|
# using the given strftime format.
|
||||||
# html_last_updated_fmt = '%b %d, %Y'
|
# html_last_updated_fmt = '%b %d, %Y'
|
||||||
html_last_updated_fmt = '%Y-%m-%d %H:%M'
|
# 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.
|
||||||
@@ -187,17 +187,6 @@ htmlhelp_basename = 'ZaqarReleaseNotesdoc'
|
|||||||
|
|
||||||
# -- 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]).
|
||||||
|
@@ -11,6 +11,7 @@ iso8601>=0.1.11 # MIT
|
|||||||
keystonemiddleware>=4.17.0 # Apache-2.0
|
keystonemiddleware>=4.17.0 # Apache-2.0
|
||||||
msgpack>=0.5.1 # Apache-2.0
|
msgpack>=0.5.1 # Apache-2.0
|
||||||
python-memcached>=1.56 # PSF
|
python-memcached>=1.56 # PSF
|
||||||
|
python-swiftclient>=3.2.0 # Apache-2.0
|
||||||
WebOb>=1.7.1 # MIT
|
WebOb>=1.7.1 # MIT
|
||||||
stevedore>=1.20.0 # Apache-2.0
|
stevedore>=1.20.0 # Apache-2.0
|
||||||
six>=1.10.0 # MIT
|
six>=1.10.0 # MIT
|
||||||
|
Reference in New Issue
Block a user