Switch to newer openstackdocstheme and reno versions
Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using these versions will allow especially: * Linking from HTML to PDF document * Allow parallel building of documents * Fix some rendering problems Update Sphinx version as well. Disable openstackdocs_auto_name to use 'project' variable as name. Change pygments_style to 'native' since old theme version always used 'native' and the theme now respects the setting and using 'sphinx' can lead to some strange rendering. Remove docs requirements from lower-constraints, they are not needed during install or test but only for docs building. openstackdocstheme renames some variables, so follow the renames before the next release removes them. A couple of variables are also not needed anymore, remove them. See also http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html Change-Id: I785707fd8bc6608285c97ff273152db52a11079d
This commit is contained in:
parent
1ceed50d36
commit
02d86ba40f
@ -87,7 +87,7 @@ add_module_names = False
|
|||||||
show_authors = False
|
show_authors = False
|
||||||
|
|
||||||
# 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 = 'native'
|
||||||
|
|
||||||
# -- Options for man page output ----------------------------------------------
|
# -- Options for man page output ----------------------------------------------
|
||||||
|
|
||||||
@ -198,3 +198,8 @@ latex_documents = [
|
|||||||
|
|
||||||
# If false, no module index is generated.
|
# If false, no module index is generated.
|
||||||
# latex_use_modindex = True
|
# latex_use_modindex = True
|
||||||
|
|
||||||
|
# -- Options for openstackdocstheme -------------------------------------------
|
||||||
|
openstackdocs_repo_name = 'openstack/tacker'
|
||||||
|
openstackdocs_bug_project = 'tacker'
|
||||||
|
openstackdocs_bug_tag = ''
|
||||||
|
@ -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.
|
||||||
sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=1.6.2 # BSD
|
sphinx>=2.0.0,!=2.1.0 # BSD
|
||||||
sphinxcontrib-apidoc>=0.2.0 # BSD
|
sphinxcontrib-apidoc>=0.2.0 # BSD
|
||||||
openstackdocstheme>=1.20.0 # Apache-2.0
|
openstackdocstheme>=2.2.1 # Apache-2.0
|
||||||
os-api-ref>=1.4.0 # Apache-2.0
|
os-api-ref>=1.4.0 # Apache-2.0
|
||||||
reno>=2.5.0 # Apache-2.0
|
reno>=3.1.0 # Apache-2.0
|
||||||
|
@ -70,7 +70,7 @@ add_function_parentheses = True
|
|||||||
add_module_names = True
|
add_module_names = True
|
||||||
|
|
||||||
# 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 = 'native'
|
||||||
|
|
||||||
# A list of ignored prefixes for module index sorting.
|
# A list of ignored prefixes for module index sorting.
|
||||||
modindex_common_prefix = ['tacker.']
|
modindex_common_prefix = ['tacker.']
|
||||||
@ -103,6 +103,7 @@ latex_documents = [
|
|||||||
#intersphinx_mapping = {'http://docs.python.org/': None}
|
#intersphinx_mapping = {'http://docs.python.org/': None}
|
||||||
|
|
||||||
# -- Options for openstackdocstheme -------------------------------------------
|
# -- Options for openstackdocstheme -------------------------------------------
|
||||||
repository_name = 'openstack/tacker'
|
openstackdocs_repo_name = 'openstack/tacker'
|
||||||
bug_project = 'tacker'
|
openstackdocs_auto_name = False
|
||||||
bug_tag = ''
|
openstackdocs_bug_project = 'tacker'
|
||||||
|
openstackdocs_bug_tag = ''
|
||||||
|
@ -60,7 +60,6 @@ munch==2.2.0
|
|||||||
netaddr==0.7.18
|
netaddr==0.7.18
|
||||||
netifaces==0.10.6
|
netifaces==0.10.6
|
||||||
oauthlib==2.0.7
|
oauthlib==2.0.7
|
||||||
openstackdocstheme==1.20.0
|
|
||||||
openstacksdk==0.44.0
|
openstacksdk==0.44.0
|
||||||
os-api-ref==1.5.0
|
os-api-ref==1.5.0
|
||||||
os-client-config==1.29.0
|
os-client-config==1.29.0
|
||||||
@ -119,7 +118,6 @@ python-swiftclient==3.5.0
|
|||||||
python-tackerclient==0.8.0
|
python-tackerclient==0.8.0
|
||||||
pytz==2018.3
|
pytz==2018.3
|
||||||
PyYAML==5.1
|
PyYAML==5.1
|
||||||
reno==2.7.0
|
|
||||||
repoze.lru==0.7
|
repoze.lru==0.7
|
||||||
requests-oauthlib==0.8.0
|
requests-oauthlib==0.8.0
|
||||||
requests==2.14.2
|
requests==2.14.2
|
||||||
@ -133,8 +131,6 @@ setuptools==21.0.0
|
|||||||
simplejson==3.13.2
|
simplejson==3.13.2
|
||||||
six==1.10.0
|
six==1.10.0
|
||||||
snowballstemmer==1.2.1
|
snowballstemmer==1.2.1
|
||||||
Sphinx==1.6.5
|
|
||||||
sphinxcontrib-websupport==1.0.1
|
|
||||||
sqlalchemy-filters==0.10.0
|
sqlalchemy-filters==0.10.0
|
||||||
sqlalchemy-migrate==0.11.0
|
sqlalchemy-migrate==0.11.0
|
||||||
SQLAlchemy==1.3.0
|
SQLAlchemy==1.3.0
|
||||||
|
@ -91,7 +91,7 @@ exclude_patterns = []
|
|||||||
# show_authors = False
|
# show_authors = False
|
||||||
|
|
||||||
# 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 = 'native'
|
||||||
|
|
||||||
# A list of ignored prefixes for module index sorting.
|
# A list of ignored prefixes for module index sorting.
|
||||||
# modindex_common_prefix = []
|
# modindex_common_prefix = []
|
||||||
@ -246,6 +246,6 @@ texinfo_documents = [
|
|||||||
locale_dirs = ['locale/']
|
locale_dirs = ['locale/']
|
||||||
|
|
||||||
# -- Options for openstackdocstheme -------------------------------------------
|
# -- Options for openstackdocstheme -------------------------------------------
|
||||||
repository_name = 'openstack/tacker'
|
openstackdocs_repo_name = 'openstack/tacker'
|
||||||
bug_project = 'tacker'
|
openstackdocs_bug_project = 'tacker'
|
||||||
bug_tag = ''
|
openstackdocs_bug_tag = ''
|
||||||
|
@ -37,7 +37,6 @@ oslo.service!=1.28.1,>=1.24.0 # Apache-2.0
|
|||||||
oslo.upgradecheck>=0.1.0 # Apache-2.0
|
oslo.upgradecheck>=0.1.0 # Apache-2.0
|
||||||
oslo.utils>=3.33.0 # Apache-2.0
|
oslo.utils>=3.33.0 # Apache-2.0
|
||||||
oslo.versionedobjects>=1.33.3 # Apache-2.0
|
oslo.versionedobjects>=1.33.3 # Apache-2.0
|
||||||
openstackdocstheme>=1.20.0 # Apache-2.0
|
|
||||||
openstacksdk>=0.44.0 # Apache-2.0
|
openstacksdk>=0.44.0 # Apache-2.0
|
||||||
python-neutronclient>=6.7.0 # Apache-2.0
|
python-neutronclient>=6.7.0 # Apache-2.0
|
||||||
python-novaclient>=9.1.0 # Apache-2.0
|
python-novaclient>=9.1.0 # Apache-2.0
|
||||||
|
Loading…
Reference in New Issue
Block a user