search

fastai / nbdev_template

Template for nbdev projects
https://nbdev.fast.ai/
Apache License 2.0
293 stars 99 forks source link

nbdev tutorial fails with new template #34

Closed migueltorres closed 3 years ago

migueltorres commented 3 years ago

I have started a new repo following the tutorial, and running nbdev_build_lib fails with a FileNotFoundError exception trying to access \docs_data\topnav.yml

That file is missing in the nbdev_template and I think is related to the new theme-based version. The helper script is not mentioned on the nbdev tutorial, and the basic procedure for creating a new nbdev repo is broken. If this template is going to be the default behaviour I think it should be reflected in the tutorial and tools (nbdev_new also leads to the same problem). If this is still an optional thing then maybe it shoud be in another branch so the regular procedure still works.

migueltorres commented 3 years ago

Updating nbdev on my computer fixes the issue (I had 1.1.5). Maybe to avoid this in the future we sould match nbdev version with specific nbdev_template tag instead of pointing to the latest master branch commit?

hamelsmu commented 3 years ago

Correct, the tutorial assumes you are using the latest version of nbdev.

We don't want to try to link templates with nbdev version as this is a one -off change. Thanks

TejasAvinashShetty commented 3 years ago

Maybe one could set up a script that tests the template each time a commit is made to see if everything still works fine. @hamelsmu @jph00 @sgugger