Merge "Switch to newer openstackdocstheme and reno versions"

This commit is contained in:
Zuul
2020-05-16 02:31:06 +00:00
committed by Gerrit Code Review
5 changed files with 22 additions and 25 deletions

View File

@@ -50,12 +50,6 @@ todo_include_todos = True
master_doc = 'index' master_doc = 'index'
# General information about the project. # General information about the project.
project = u'Compute API Guide' project = u'Compute API Guide'
bug_tag = u'api-guide'
repository_name = 'openstack/nova'
bug_project = 'nova'
# Must set this variable to include year, month, day, hours, and minutes.
html_last_updated_fmt = '%Y-%m-%d %H:%M'
copyright = u'2015, OpenStack contributors' copyright = u'2015, OpenStack contributors'
@@ -147,10 +141,6 @@ html_static_path = []
# 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
@@ -284,9 +274,15 @@ pdf_documents = [
# -- Options for openstackdocstheme ------------------------------------------- # -- Options for openstackdocstheme -------------------------------------------
openstack_projects = [ openstackdocs_projects = [
'glance', 'glance',
'nova', 'nova',
'neutron', 'neutron',
'placement', 'placement',
] ]
openstackdocs_bug_tag = u'api-guide'
openstackdocs_repo_name = 'openstack/nova'
openstackdocs_bug_project = 'nova'
openstackdocs_auto_version = False
openstackdocs_auto_name = False

View File

@@ -43,9 +43,9 @@ master_doc = 'index'
copyright = u'2010-present, OpenStack Foundation' copyright = u'2010-present, OpenStack Foundation'
# openstackdocstheme options # openstackdocstheme options
repository_name = 'openstack/nova' openstackdocs_repo_name = 'openstack/nova'
bug_project = 'nova' openstackdocs_bug_project = 'nova'
bug_tag = 'api-ref' openstackdocs_bug_tag = 'api-ref'
# The name of the Pygments (syntax highlighting) style to use. # The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx' pygments_style = 'sphinx'

View File

@@ -1,16 +1,16 @@
# 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.
sphinx>=1.8.0,!=2.1.0 # BSD sphinx>=2.0.0,!=2.1.0 # BSD
sphinxcontrib-actdiag>=0.8.5 # BSD sphinxcontrib-actdiag>=0.8.5 # BSD
sphinxcontrib-seqdiag>=0.8.4 # BSD sphinxcontrib-seqdiag>=0.8.4 # BSD
sphinxcontrib-svg2pdfconverter>=0.1.0 # BSD sphinxcontrib-svg2pdfconverter>=0.1.0 # BSD
sphinx-feature-classification>=0.2.0 # Apache-2.0 sphinx-feature-classification>=0.2.0 # Apache-2.0
os-api-ref>=1.4.0 # Apache-2.0 os-api-ref>=1.4.0 # Apache-2.0
openstackdocstheme>=1.30.0 # Apache-2.0 openstackdocstheme>=2.1.2 # Apache-2.0
# releasenotes # releasenotes
reno>=2.5.0 # Apache-2.0 reno>=3.1.0 # Apache-2.0
# redirect tests in docs # redirect tests in docs
whereto>=0.3.0 # Apache-2.0 whereto>=0.3.0 # Apache-2.0

View File

@@ -47,10 +47,6 @@ extensions = [
'sphinxcontrib.rsvgconverter', 'sphinxcontrib.rsvgconverter',
] ]
# openstackdocstheme options
repository_name = 'openstack/nova'
bug_project = 'nova'
bug_tag = 'doc'
config_generator_config_file = '../../etc/nova/nova-config-generator.conf' config_generator_config_file = '../../etc/nova/nova-config-generator.conf'
sample_config_basename = '_static/nova' sample_config_basename = '_static/nova'
@@ -142,11 +138,16 @@ latex_use_xindy = False
# -- Options for openstackdocstheme ------------------------------------------- # -- Options for openstackdocstheme -------------------------------------------
# openstackdocstheme options
openstackdocs_repo_name = 'openstack/nova'
openstackdocs_bug_project = 'nova'
openstackdocs_bug_tag = 'doc'
# keep this ordered to keep mriedem happy # keep this ordered to keep mriedem happy
# #
# NOTE(stephenfin): Projects that don't have a release branch, like TripleO and # NOTE(stephenfin): Projects that don't have a release branch, like TripleO and
# reno, should not be included here # reno, should not be included here
openstack_projects = [ openstackdocs_projects = [
'ceilometer', 'ceilometer',
'cinder', 'cinder',
'cyborg', 'cyborg',

View File

@@ -43,9 +43,9 @@ master_doc = 'index'
# General information about the project. # General information about the project.
copyright = u'2015, Nova developers' copyright = u'2015, Nova developers'
# openstackdocstheme options # openstackdocstheme options
repository_name = 'openstack/nova' openstackdocs_repo_name = 'openstack/nova'
bug_project = 'nova' openstackdocs_bug_project = 'nova'
bug_tag = '' openstackdocs_bug_tag = ''
# 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.