Need help with nbdev_template?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

fastai
200 Stars 83 Forks Apache License 2.0 110 Commits 3 Opened issues

Description

Template for nbdev projects

Services available

!
?

Need anything else?

Contributors list

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).

Troubleshooting Tips

  • 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.ini
    or 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 from
    settings.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
    , run
    nbdev_build_lib && nbdev_clean_nbs && nbdev_build_docs
    to make sure all changes are propagated appropriately.

Previewing Documents Locally

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).

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.