swcarpentry / DEPRECATED-bc

DEPRECATED: This repository is now frozen - please see individual lesson repositories.
Other
299 stars 383 forks source link

Documented some undocumented build requirements (PyYAML and IPython >=1.1.0) #863

Closed jameshiebert closed 7 years ago

jameshiebert commented 9 years ago

I was slowed down but a couple of requirements that I didn't see stated in the contributor's guide. The PyYAML package is used by swc_index_validator.py (i.e. what make check performs).

Also I had an old version of IPython (Gentoo still masks everything > 1.0), and got this warning when running make ipynb:

[NbConvertApp] WARNING | Unexpected exception loading template: _templates/ipynb.tpl
Traceback (most recent call last):
  File "/usr/lib64/python2.7/site-packages/IPython/nbconvert/exporters/exporter.py", line 230, in _load_template
    self.template = self.environment.get_template(try_name)
  File "/usr/lib64/python2.7/site-packages/jinja2/environment.py", line 791, in get_template
    return self._load_template(name, self.make_globals(globals))
  File "/usr/lib64/python2.7/site-packages/jinja2/environment.py", line 765, in _load_template
    template = self.loader.load(self, name, globals)
  File "/usr/lib64/python2.7/site-packages/jinja2/loaders.py", line 395, in load
    return loader.load(environment, name, globals)
  File "/usr/lib64/python2.7/site-packages/jinja2/loaders.py", line 125, in load
    code = environment.compile(source, name, filename)
  File "/usr/lib64/python2.7/site-packages/jinja2/environment.py", line 554, in compile
    self.handle_exception(exc_info, source_hint=source)
  File "/usr/lib64/python2.7/site-packages/jinja2/environment.py", line 742, in handle_exception
    reraise(exc_type, exc_value, tb)
  File "./_templates/ipynb.tpl", line 21, in <module>
    {%- block data_svg -%}<img src="../../{{ output.svg_filename | path2url }}">{%- endblock data_svg -%}
TemplateAssertionError: no filter named 'path2url'

I tracked down the version of IPython in which path2url was introduced: 1.1.0 and noted that in the makefile. Not sure if that's the best place to document it. Feedback welcome.

gvwilson commented 9 years ago

Hi James, Thanks for this - we're probably not going to merge it, since we've moved stuff over to the new lesson-template and workshop-template repos, but I'll take it as proof that you're a Git wizard for teaching purposes :-) Cheers, Greg

gvwilson commented 7 years ago

This repository has been retired.