Things to change after cloning the template
- change project name in
pyproject.toml
- poetry install (need previous step to be done for the current project to install)
- Follow nbdev tutorial | nbdev
- settings.ini
- Change
lib_name
and other settings - Choose
doc_base_url
based on public or private page
- Change
- set up git hooks using nbdev_install_git_hooks
nbdev_build_lib
nbdev_build_docs
- settings.ini
- Enable caching again in
.github/workflows/main.yml
git add .
git commit -m “Configure package from template”
- Set up GitHub pages
nbdev template
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).