Details
-
Type:
Bug
-
Status: Done
-
Resolution: Done
-
Fix Version/s: None
-
Component/s: templates
-
Labels:None
-
Story Points:1.8
-
Epic Link:
-
Team:SQuaRE
Description
The sqrbot setup PR for ittn-004 failed with a spinx-build error:
https://travis-ci.com/lsst-it/ittn-004/builds/130548516 |
|
|
$ source ~/virtualenv/python3.7/bin/activate |
|
|
$ python --version
|
|
|
Python 3.7.1 |
|
|
$ pip --version
|
|
|
pip 19.0.3 from /home/[secure]/virtualenv/python3.7.1/lib/python3.7/site-packages/pip (python 3.7) |
install.1 |
|
|
15.98s$ pip install -r requirements.txt |
install.2 |
|
|
2.80s$ pip install "ltd-conveyor>=0.4.2,<0.5" |
|
|
0.48s$ sphinx-build -b html -a -n -d _build/doctree . _build/html |
|
|
Running Sphinx v1.7.9 |
|
|
/home/[secure]/virtualenv/python3.7.1/lib/python3.7/site-packages/documenteer/sphinxconfig/technoteconf.py:65: YAMLLoadWarning: calling yaml.load() without Loader=... is deprecated, as the default Loader is unsafe. Please read https://msg.pyyaml.org/load for full details. |
|
|
_metadata = yaml.load(meta_stream)
|
|
|
Configuration error:
|
|
|
There is a programable error in your configuration file:
|
|
|
Traceback (most recent call last):
|
|
|
File "/home/[secure]/virtualenv/python3.7.1/lib/python3.7/site-packages/sphinx/config.py", line 161, in __init__ |
|
|
execfile_(filename, config)
|
|
|
File "/home/[secure]/virtualenv/python3.7.1/lib/python3.7/site-packages/sphinx/util/pycompat.py", line 150, in execfile_ |
|
|
exec_(code, _globals)
|
|
|
File "conf.py", line 14, in <module> |
|
|
confs = configure_technote(f)
|
|
|
File "/home/[secure]/virtualenv/python3.7.1/lib/python3.7/site-packages/documenteer/sphinxconfig/technoteconf.py", line 65, in configure_technote |
|
|
_metadata = yaml.load(meta_stream)
|
|
|
File "/home/[secure]/virtualenv/python3.7.1/lib/python3.7/site-packages/yaml/__init__.py", line 114, in load |
|
|
return loader.get_single_data() |
|
|
File "/home/[secure]/virtualenv/python3.7.1/lib/python3.7/site-packages/yaml/constructor.py", line 41, in get_single_data |
|
|
node = self.get_single_node()
|
|
|
File "/home/[secure]/virtualenv/python3.7.1/lib/python3.7/site-packages/yaml/composer.py", line 36, in get_single_node |
|
|
document = self.compose_document()
|
|
|
File "/home/[secure]/virtualenv/python3.7.1/lib/python3.7/site-packages/yaml/composer.py", line 55, in compose_document |
|
|
node = self.compose_node(None, None)
|
|
|
File "/home/[secure]/virtualenv/python3.7.1/lib/python3.7/site-packages/yaml/composer.py", line 84, in compose_node |
|
|
node = self.compose_mapping_node(anchor)
|
|
|
File "/home/[secure]/virtualenv/python3.7.1/lib/python3.7/site-packages/yaml/composer.py", line 127, in compose_mapping_node |
|
|
while not self.check_event(MappingEndEvent): |
|
|
File "/home/[secure]/virtualenv/python3.7.1/lib/python3.7/site-packages/yaml/parser.py", line 98, in check_event |
|
|
self.current_event = self.state()
|
|
|
File "/home/[secure]/virtualenv/python3.7.1/lib/python3.7/site-packages/yaml/parser.py", line 439, in parse_block_mapping_key |
|
|
"expected <block end>, but found %r" % token.id, token.start_mark) |
|
|
yaml.parser.ParserError: while parsing a block mapping |
|
|
in "/home/[secure]/build/lsst-it/ittn-004/metadata.yaml", line 6, column 1 |
|
|
expected <block end>, but found '<scalar>' |
|
|
in "/home/[secure]/build/lsst-it/ittn-004/metadata.yaml", line 40, column 48 |
|
|
The command "sphinx-build -b html -a -n -d _build/doctree . _build/html" exited with 2. |
|
|
Done. Your build exited with 1. |
Attachments
Activity
Ok, will do.
- Released version 0.3.0 of templatekit with a new Jinja filter for escaping YAML strings https://templatekit.lsst.io/v/0.3.0/template-guide/templatekit-jinja-extensions.html#escape-yaml-doublequoted and published tips on templating YAML files: https://templatekit.lsst.io/v/0.3.0/template-guide/templating-yaml-files.html
- Updated the technote_rst and nbreport templates to use this new Jinja filter: https://github.com/lsst/templates/pull/50
Updated templatebot to use version 0.3.0 of templatekit.
Jonathan Sick The problem was that the creation wizard allowed ' to be input as part of the technote description. Possible preventive measure might be filtering out the quotes, escaping them, or some sort of input validation error returned to the user.
$ git diff 9c747c09a9d40e006096dda2cabdaca4dff036bf^!diff --git a/metadata.yaml b/metadata.yaml--- a/metadata.yaml+++ b/metadata.yaml# Title of the document, without the series/serial designationauthors: