openstack
/
monasca-log-api
Code Issues Proposed changes

Merge "Switch to newer openstackdocstheme and reno versions"

This commit is contained in:
Zuul 2020-05-26 19:10:46 +00:00 committed by Gerrit Code Review
parent 95c7774a6d a8d2c2e2da
commit fc3c885e3e
6 changed files with 32 additions and 60 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
api-guide/source/conf.py
View File

@ -41,15 +41,12 @@ source_encoding = 'utf-8'
master_doc = 'index'
# General details about project
repository_name = u'openstack/monasca-log-api'
project = u'Monasca Log API Guide'
bug_project = u'monasca-log-api'
bug_tag = u'api-guide'
copyright = u'2014, OpenStack Foundation'
from monasca_log_api.version import version_info
version = version_info.version_string()
release = version_info.release_string()
openstackdocs_repo_name = 'openstack/monasca-log-api'
openstackdocs_auto_name = False
project = 'Monasca Log API Guide'
openstackdocs_bug_project = 'monasca-log-api'
openstackdocs_bug_tag = 'api-guide'
copyright = '2014, OpenStack Foundation'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
@ -81,7 +78,7 @@ exclude_patterns = []
# show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
pygments_style = 'native'
# A list of ignored prefixes for module index sorting.
# modindex_common_prefix = []
@ -123,10 +120,6 @@ html_short_title = 'API Guide'
# 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

25
api-ref/source/conf.py
View File

@ -42,19 +42,12 @@ source_encoding = 'utf-8'
master_doc = 'index'
# General details about project
repository_name = u'openstack/monasca-log-api'
project = u'Monasca Log Ref Guide'
bug_project = u'monasca-log-api'
bug_tag = u'api-ref'
copyright = u'2014, 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 monasca_log_api.version import version_info
version = version_info.version_string()
release = version_info.release_string()
openstackdocs_repo_name = 'openstack/monasca-log-api'
openstackdocs_auto_name = False
project = 'Monasca Log Ref Guide'
openstackdocs_bug_project = 'monasca-log-api'
openstackdocs_bug_tag = 'api-ref'
copyright = '2014, OpenStack Foundation'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
@ -86,7 +79,7 @@ exclude_patterns = []
# show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
pygments_style = 'native'
# A list of ignored prefixes for module index sorting.
# modindex_common_prefix = []
@ -131,10 +124,6 @@ html_short_title = 'API Ref'
# 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

17
doc/source/conf.py
View File

@ -15,8 +15,6 @@
import os
import sys
from monasca_log_api.version import version_info
sys.path = [
os.path.abspath('../..'),
os.path.abspath('../../bin')
@ -43,12 +41,11 @@ extensions = [
]
# geeneral information about project
repository_name = u'openstack/monasca-log-api'
openstackdocs_repo_name = u'openstack/monasca-log-api'
openstackdocs_auto_name = False
project = u'Monasca Log Dev Docs'
version = version_info.version_string()
release = version_info.release_string()
bug_project = u'monasca-log-api'
bug_tag = u'doc'
openstackdocs_bug_project = u'monasca-log-api'
openstackdocs_bug_tag = u'doc'
copyright = u'2014-present, OpenStack Foundation'
author = u'OpenStack Foundation'
@ -96,7 +93,7 @@ add_module_names = True
show_authors = True
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
pygments_style = 'native'
# A list of ignored prefixes for module index sorting.
modindex_common_prefix = ['monasca_log_api.', 'monasca']
@ -141,10 +138,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

8
lower-constraints.txt
View File

@ -38,8 +38,8 @@ mox3==0.20.0
msgpack-python==0.4.0
netaddr==0.7.18
netifaces==0.10.4
openstackdocstheme==1.18.1
os-api-ref==1.4.0
openstackdocstheme==2.2.1
os-api-ref==1.5.0
os-client-config==1.28.0
os-testr==1.0.0
oslo.config==5.2.0
@ -69,7 +69,7 @@ python-statsd==2.1.0
python-subunit==1.0.0
pytz==2013.6
PyYAML==3.12
reno==2.5.0
reno==3.1.0
requests==2.14.2
requestsexceptions==1.2.0
restructuredtext-lint==1.1.1
@ -78,7 +78,7 @@ simplejson==3.8.1
six==1.10.0
smmap==0.9.0
snowballstemmer==1.2.1
Sphinx==1.6.2
Sphinx==2.0.0
sphinxcontrib-websupport==1.0.1
statsd==3.2.1
stestr==1.0.0

13
releasenotes/source/conf.py
View File

@ -37,10 +37,11 @@ source_encoding = 'utf-8'
master_doc = 'index'
# General information about the project.
repository_name = u'openstack/monasca-log-api'
openstackdocs_repo_name = u'openstack/monasca-log-api'
openstackdocs_auto_name = False
project = u'Monasca Log Release Notes'
bug_project = u'monasca-log-api'
bug_tag = u'releasenotes'
openstackdocs_bug_project = u'monasca-log-api'
openstackdocs_bug_tag = u'releasenotes'
copyright = u'2014, OpenStack Foundation'
# Release notes do not need a version number in the title, they
@ -78,7 +79,7 @@ exclude_patterns = []
# show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
pygments_style = 'native'
# A list of ignored prefixes for module index sorting.
# modindex_common_prefix = []
@ -127,10 +128,6 @@ html_theme = 'openstackdocs'
# 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

8
test-requirements.txt
View File

@ -16,7 +16,7 @@ simplejson>=3.8.1 # MIT
# documentation
doc8>=0.6.0 # Apache-2.0
sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=1.6.2;python_version>='3.4' # BSD
os-api-ref>=1.4.0 # Apache-2.0
reno>=2.5.0 # Apache-2.0
openstackdocstheme>=1.18.1 # Apache-2.0
sphinx>=2.0.0,!=2.1.0 # BSD
os-api-ref>=1.5.0 # Apache-2.0
reno>=3.1.0 # Apache-2.0
openstackdocstheme>=2.2.1 # Apache-2.0