Update docs bug links to storyboard

Update doc, api-ref and releasenotes conf.py to set 'use_storyboard' to
True. According to the docs of the theme [1] bug project and tag are
not used when using StoryBoard.

doc/requirements.txt (used by all the docs-related jobs) is updated
to make openstackdocstheme>=1.24.0. That version is the most recent
one to have bug fixes related to use_storyboard.

[1] https://docs.openstack.org/openstackdocstheme/latest/#using-the-theme

Change-Id: I3b28dd1da9e8e75eda151a3025e78a5a47c971f9
Story: 2005190
Task: 29948
This commit is contained in:
Chris Dent 2019-03-11 18:49:11 +00:00
parent b895b02c6d
commit 2588c7b8da
4 changed files with 4 additions and 8 deletions

View File

@ -54,8 +54,7 @@ copyright = u'2010-present, OpenStack Foundation'
# openstackdocstheme options
repository_name = 'openstack/placement'
bug_project = 'nova'
bug_tag = 'api-ref'
use_storyboard = True
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the

View File

@ -6,7 +6,7 @@ sphinxcontrib-actdiag>=0.8.5 # BSD
sphinxcontrib-seqdiag>=0.8.4 # BSD
sphinx-feature-classification>=0.2.0 # Apache-2.0
os-api-ref>=1.4.0 # Apache-2.0
openstackdocstheme>=1.19.0 # Apache-2.0
openstackdocstheme>=1.24.0 # Apache-2.0
# releasenotes
reno>=2.5.0 # Apache-2.0

View File

@ -53,8 +53,7 @@ extensions = ['sphinx.ext.autodoc',
# openstackdocstheme options
repository_name = 'openstack/placement'
bug_project = 'nova'
bug_tag = 'doc'
use_storyboard = True
config_generator_config_file = '../../etc/placement/config-generator.conf'
sample_config_basename = '_static/placement'

View File

@ -50,9 +50,7 @@ copyright = u'2018, Placement developers'
author = u'OpenStack'
# openstackdocstheme options
repository_name = 'openstack/placement'
# TODO(cdent): This will change to something else later.
bug_project = 'nova'
bug_tag = 'placement'
use_storyboard = True
# The language for content autogenerated by Sphinx. Refer to documentation