openstack/glance_store
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.

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: Iee357adb23ff65e453ac627eaec0b9d7ac245ba6
This commit is contained in:
Andreas Jaeger 2020-05-30 16:57:25 +02:00
parent 4de8d3c2d6
commit 7eb1635425
4 changed files with 13 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/requirements.txt
View File

@ -1,7 +1,7 @@
# 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,>=1.6.2 # BSD sphinx>=2.0.0,!=2.1.0 # BSD
openstackdocstheme>=1.18.1 # Apache-2.0 openstackdocstheme>=2.2.1 # Apache-2.0
reno>=2.5.0 # Apache-2.0 reno>=3.1.0 # Apache-2.0
sphinxcontrib-apidoc>=0.2.0 # BSD sphinxcontrib-apidoc>=0.2.0 # BSD

10
doc/source/conf.py
View File

@ -25,10 +25,10 @@ extensions = ['openstackdocstheme',
'sphinxcontrib.apidoc'] 'sphinxcontrib.apidoc']
# openstackdocstheme options # openstackdocstheme options
repository_name = 'openstack/glance_store' openstackdocs_repo_name = 'openstack/glance_store'
bug_project = 'glance-store' openstackdocs_auto_name = False
bug_tag = '' openstackdocs_bug_project = 'glance-store'
html_last_updated_fmt = '%Y-%m-%d %H:%M' openstackdocs_bug_tag = ''
# sphinxcontrib.apidoc options # sphinxcontrib.apidoc options
apidoc_module_dir = '../../glance_store' apidoc_module_dir = '../../glance_store'
@ -63,7 +63,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'
# -- Options for HTML output -------------------------------------------------- # -- Options for HTML output --------------------------------------------------

4
lower-constraints.txt
View File

@ -36,7 +36,6 @@ mox3==0.25.0
msgpack==0.5.6 msgpack==0.5.6
netaddr==0.7.19 netaddr==0.7.19
netifaces==0.10.6 netifaces==0.10.6
openstackdocstheme==1.18.1
os-brick==2.6.0 os-brick==2.6.0
os-client-config==1.29.0 os-client-config==1.29.0
oslo.concurrency==3.26.0 oslo.concurrency==3.26.0
@ -63,7 +62,6 @@ python-subunit==1.0.0
python-swiftclient==3.2.0 python-swiftclient==3.2.0
pytz==2018.3 pytz==2018.3
PyYAML==3.12 PyYAML==3.12
reno==2.5.0
requests==2.14.2 requests==2.14.2
requestsexceptions==1.4.0 requestsexceptions==1.4.0
requests-mock==1.2.0 requests-mock==1.2.0
@ -72,8 +70,6 @@ rfc3986==1.1.0
six==1.10.0 six==1.10.0
smmap2==2.0.3 smmap2==2.0.3
snowballstemmer==1.2.1 snowballstemmer==1.2.1
Sphinx==1.6.2
sphinxcontrib-websupport==1.0.1
stestr==2.0.0 stestr==2.0.0
stevedore==1.20.0 stevedore==1.20.0
testscenarios==0.4 testscenarios==0.4

10
releasenotes/source/conf.py
View File

@ -38,10 +38,10 @@ extensions = [
] ]
# openstackdocstheme options # openstackdocstheme options
repository_name = 'openstack/glance_store' openstackdocs_repo_name = 'openstack/glance_store'
bug_project = 'glance-store' openstackdocs_auto_name = False
bug_tag = '' openstackdocs_bug_project = 'glance-store'
html_last_updated_fmt = '%Y-%m-%d %H:%M' openstackdocs_bug_tag = ''
# Add any paths that contain templates here, relative to this directory. # Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates'] templates_path = ['_templates']
@ -93,7 +93,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 = []