⚠️ This template is for an old version of nbdev, nbdev v1. The template for v2 is here
Use this template to more easily create your nbdev project.
If you are using an older version of this template, and want to upgrade to the theme-based version, see this helper script (more explanation of what this means is contained in the link to the script).
- Make sure you are using the latest version of nbdev with
pip install -U nbdev - If you are using an older version of this template, see the instructions above on how to upgrade your template.
- It is important for you to spell the name of your user and repo correctly in
settings.inior the website will not have the correct address from which to source assets like CSS for your site. When in doubt, you can open your browser's developer console and see if there are any errors related to fetching assets for your website due to an incorrect URL generated by misspelled values fromsettings.ini. - If you change the name of your repo, you have to make the appropriate changes in
settings.ini - After you make changes to
settings.ini, runnbdev_build_lib && nbdev_clean_nbs && nbdev_build_docsto make sure all changes are propagated appropriately.
It is often desirable to preview nbdev generated documentation locally before having it built and rendered by GitHub Pages. This requires you to run Jekyll locally, which requires installing Ruby and Jekyll. Instructions on how to install Jekyll are provided on Jekyll's site. You can run the command make docs_serve from the root of your repo to serve the documentation locally after calling nbdev_build_docs to generate the docs.
In order to allow you to run Jekyll locally this project contains manifest files, called Gem files, that specify all Ruby dependencies for Jekyll & nbdev. If you do not plan to preview documentation locally, you can choose to delete docs/Gemfile and docs/Gemfile.lock from your nbdev project (for example, after creating a new repo from this template).