https://github.com/fastai/nbdev_template

Template for nbdev projects
https://github.com/fastai/nbdev_template

documentation-generator documentation-tool jupyter jupyter-notebook literate-programming python

Last synced: about 1 month ago
JSON representation

Template for nbdev projects

• Host: GitHub
• URL: https://github.com/fastai/nbdev_template
• Owner: fastai
• License: apache-2.0
• Created: 2019-11-25T19:11:09.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2022-07-24T14:01:28.000Z (over 2 years ago)
• Last Synced: 2024-08-01T16:34:34.190Z (4 months ago)
• Topics: documentation-generator, documentation-tool, jupyter, jupyter-notebook, literate-programming, python
• Language: Python
• Homepage: https://nbdev.fast.ai/
• Size: 1.06 MB
• Stars: 290
• Watchers: 13
• Forks: 99
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - fastai/nbdev_template - Template for nbdev projects (Python)
• awesome-starred - fastai/nbdev_template - Template for nbdev projects (python)

README

        
# :warning: This template is for an old version of nbdev, nbdev v1.  The template for v2 is [here](https://github.com/fastai/nbdev-template)

# nbdev template

Use this template to more easily create your [nbdev](https://nbdev.fast.ai/) project.

_If you are using an older version of this template, and want to upgrade to the theme-based version, see [this helper script](https://gist.github.com/hamelsmu/977e82a23dcd8dcff9058079cb4a8f18) (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](https://jekyllrb.com/). 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).