Skip to content

Instantly share code, notes, and snippets.

@dienhoa

dienhoa/docment-notes.md

Last active February 19, 2022 05:20
Show Gist options
  • Star 1 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save dienhoa/547664c51940906556a15a08cef70e54 to your computer and use it in GitHub Desktop.
Save dienhoa/547664c51940906556a15a08cef70e54 to your computer and use it in GitHub Desktop.
Download ZIP
It's my note about useful commands I use during the docment sprint https://github.com/muellerzr/fastai-docment-sprint
Raw
docment-notes.md

Run 3 commands below when you prepare your PR

nbdev_build_lib 

nbdev_build_docs —fname {path the to file}

nbdev_clean_nbs

Set up hook to reduce change you have conflict in Jupyter Notebook with metadata (https://nbdev.fast.ai/cli.html#nbdev_install_git_hooks):

nbdev_install_git_hooks

Make sure no difference between the library and notebooks (https://nbdev.fast.ai/cli.html#nbdev_diff_nbs):

nbdev_diff_nbs

In Docment, surround a type with back tick ` so that it can create hot link (help user to find related information)

@malligaraj
Copy link

Thank you for this guide 🏅. I did not know how to pass a single file to nbdev_build_docs

@dienhoa
Copy link
Author

dienhoa commented Feb 18, 2022

@malligaraj you're welcome. It's in the streaming of Zach, super useful that we don't need to build the whole library (take a long time and have to set up correct environment)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment