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

Set openstackdocs_auto_name to use 'project' 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: Ie623e7a2389c292ffc71a285f0fc2d4bb9820c3f
This commit is contained in:
melissaml 2020-05-22 18:17:12 +08:00
parent 699bbff966
commit e195c8112b
5 changed files with 18 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -61,10 +61,10 @@ master_doc = 'index'
project = u'Messaging Service API Reference' project = u'Messaging Service API Reference'
copyright = u'2010-present, OpenStack Foundation' copyright = u'2010-present, OpenStack Foundation'
repository_name = 'openstack/zaqar' # openstackdocstheme options
bug_project = 'zaqar' openstackdocs_repo_name = 'openstack/zaqar'
bug_tag = '' openstackdocs_bug_project = 'zaqar'
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.
@ -93,7 +93,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 ----------------------------------------------

6
doc/requirements.txt
View File

@ -1,10 +1,10 @@
# 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.
openstackdocstheme>=1.31.2 # Apache-2.0 openstackdocstheme>=2.2.1 # Apache-2.0
sphinx!=1.6.6,!=1.6.7,>=1.6.3 # BSD sphinx>=2.0.0,!=2.1.0 # BSD
sphinxcontrib-apidoc>=0.2.0 # BSD sphinxcontrib-apidoc>=0.2.0 # BSD
reno>=2.5.0 # Apache-2.0 reno>=3.1.0 # Apache-2.0
os-api-ref>=1.4.0 # Apache-2.0 os-api-ref>=1.4.0 # Apache-2.0
pymongo>=3.6.0 # Apache-2.0 pymongo>=3.6.0 # Apache-2.0
redis>=2.10.0 # MIT redis>=2.10.0 # MIT

10
doc/source/conf.py
View File

@ -117,7 +117,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'
# A list of ignored prefixes for module index sorting. # A list of ignored prefixes for module index sorting.
modindex_common_prefix = ['zaqar.'] modindex_common_prefix = ['zaqar.']
@ -236,7 +236,7 @@ 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 ------------------------------------------- # Options for openstackdocstheme
repository_name = 'openstack/zaqar' openstackdocs_repo_name = 'openstack/zaqar'
bug_project = 'zaqar' openstackdocs_bug_project = 'zaqar'
bug_tag = '' openstackdocs_bug_tag = ''

4
lower-constraints.txt
View File

@ -18,7 +18,6 @@ keystoneauth1==3.4.0
keystonemiddleware==4.17.0 keystonemiddleware==4.17.0
mock==2.0.0 mock==2.0.0
msgpack==0.5.1 msgpack==0.5.1
openstackdocstheme==1.31.2
os-api-ref==1.4.0 os-api-ref==1.4.0
os-client-config==1.28.0 os-client-config==1.28.0
os-testr==1.0.0 os-testr==1.0.0
@ -50,14 +49,11 @@ python-swiftclient==3.2.0
pytz==2013.6 pytz==2013.6
PyYAML==3.12 PyYAML==3.12
redis==3.0.0 redis==3.0.0
reno==2.5.0
requests==2.14.2 requests==2.14.2
requestsexceptions==1.2.0 requestsexceptions==1.2.0
restructuredtext-lint==1.1.1 restructuredtext-lint==1.1.1
rfc3986==0.3.1 rfc3986==0.3.1
six==1.10.0 six==1.10.0
sphinx===1.6.2
sphinxcontrib-websupport==1.0.1
SQLAlchemy==1.0.10 SQLAlchemy==1.0.10
sqlalchemy-migrate==0.11.0 sqlalchemy-migrate==0.11.0
stestr==2.0.0 stestr==2.0.0

10
releasenotes/source/conf.py
View File

@ -90,7 +90,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 = []
@ -256,7 +256,7 @@ texinfo_documents = [
# -- Options for Internationalization output ------------------------------ # -- Options for Internationalization output ------------------------------
locale_dirs = ['locale/'] locale_dirs = ['locale/']
# -- Options for openstackdocstheme ------------------------------------------- # Options for openstackdocstheme
repository_name = 'openstack/zaqar' openstackdocs_repo_name = 'openstack/zaqar'
bug_project = 'zaqar' openstackdocs_bug_project = 'zaqar'
bug_tag = '' openstackdocs_bug_tag = ''