openstack
/
openstackdocstheme
Code Issues Proposed changes

Fix use_storyboard 

Initialize variable with False and not with empty string - the variable
is a boolean.

Update example.

Changed this so that
use_storybard = true
in doc/source/conf.py will not result in:

  The config value `use_storyboard' has type `bool', defaults to `str'.

Change-Id: I2ed164b9b0badade702c50543ac1a5eea4d1867b
This commit is contained in:
Andreas Jaeger 2018-09-04 21:10:19 +02:00
parent 344b423e01
commit fde94a8a86
2 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/source/index.rst
View File

@ -78,6 +78,7 @@ Using the theme
# openstackdocstheme options
repository_name = 'openstack-infra/infra-manual'
use_storyboard = True
bug_project = 'openstack-ci'
bug_tag = ''

2
openstackdocstheme/ext.py
View File

@ -297,7 +297,7 @@ def setup(app):
app.add_config_value('bug_project', '', 'env')
app.add_config_value('bug_tag', '', 'env')
app.add_config_value('openstack_projects', [], 'env')
app.add_config_value('use_storyboard', '', 'env')
app.add_config_value('use_storyboard', False, 'env')
app.add_html_theme(
'openstackdocs',
os.path.abspath(os.path.dirname(__file__)) + '/theme/openstackdocs',