openstack/trove
Code Issues Proposed changes

Switch to newer openstackdocstheme and reno versions

Browse Source 
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.

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: Ic5ff4981e5ed09885fd2aaad7508d58d2b2cccc7
This commit is contained in:
melissaml 2020-05-22 17:31:47 +08:00 committed by Andreas Jaeger
parent 3202b321b3
commit b77f7b9fe7
5 changed files with 19 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -36,9 +36,10 @@ html_theme = 'openstackdocs'
html_theme_options = {
"sidebar_mode": "toc",
}
repository_name = 'openstack/trove'
bug_project = 'trove'
bug_tag = ''
openstackdocs_repo_name = 'openstack/trove'
openstack_auto_name = False
openstackdocs_bug_project = 'trove'
openstackdocs_bug_tag = ''
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
@ -93,7 +94,7 @@ add_module_names = False
show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
pygments_style = 'native'
# -- Options for man page output ----------------------------------------------

13
doc/source/conf.py
View File

@ -19,9 +19,10 @@ extensions = ['sphinx.ext.todo',
'stevedore.sphinxext']
# openstackdocstheme options
repository_name = 'openstack/trove'
bug_project = 'trove'
bug_tag = ''
openstackdocs_repo_name = 'openstack/trove'
openstackdocs_bug_project = 'trove'
openstack_auto_name = False
openstackdocs_bug_tag = ''
html_theme = 'openstackdocs'
# Add any paths that contain templates here, relative to this directory.
@ -69,7 +70,7 @@ add_module_names = True
#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 = ['trove.']
@ -114,10 +115,6 @@ modindex_common_prefix = ['trove.']
# so a file named "default.css" will overwrite the builtin "default.css".
# 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'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#html_use_smartypants = True

4
lower-constraints.txt
View File

@ -67,7 +67,7 @@ networkx==1.11
nose==1.3.7
nosexcover==1.0.10
openstack.nose-plugin==0.7
openstackdocstheme==1.32.1
openstackdocstheme==2.2.1
openstacksdk==0.12.0
os-api-ref==1.4.0
os-client-config==1.29.0
@ -128,7 +128,7 @@ python-troveclient==2.2.0
pytz==2018.3
PyYAML==3.12
redis==2.10.0
reno==2.5.0
reno==3.1.0
repoze.lru==0.7
requests==2.18.4
requestsexceptions==1.4.0

10
releasenotes/source/conf.py
View File

@ -43,10 +43,10 @@ extensions = [
]
# openstackdocstheme options
repository_name = 'openstack/trove'
bug_project = 'trove'
bug_tag = ''
html_last_updated_fmt = '%Y-%m-%d %H:%M'
openstackdocs_repo_name = 'openstack/trove'
openstack_auto_name = False
openstackdocs_bug_project = 'trove'
openstackdocs_bug_tag = ''
html_theme = 'openstackdocs'
# Add any paths that contain templates here, relative to this directory.
@ -103,7 +103,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 = []

4
test-requirements.txt
View File

@ -25,6 +25,6 @@ pylint==1.9.2 # GPLv2
oslotest>=3.2.0 # Apache-2.0
tenacity>=4.9.0 # Apache-2.0
# Docs building
openstackdocstheme>=1.32.1 # Apache-2.0
openstackdocstheme>=2.2.1 # 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