project page
Project description
README
Get started
-
Create a new project using this template
-
run
make init_repository
to initialize the repo for nbdev -
run
nbdev_preview
to makesure nbdev renders the website -
modify
setting.ini
and_quarto.yml
as needed to reflect names and hyperlinks of this project -
add notebook in the
nbs
folder and start building software -
git add
,git commit
,git push
to save your work
Deploy manually
-
make deploy_to_githubpage
to deploy the website to github pages -
from github, go to
Settings
->Pages
to set the source of the github page tomain
branch and/docs
folder andsave
-
visit the website at
https://<username>.github.io/<project_name>
-
in the future you can run
make deploy_to_githubpage
to update the website automatically
Deploy automatically
-
first, go to
Settings
->Actions
->general
->Workflows Permissions
and enableRead and write access
forActions
andWorkflows
-
from github, go to
Settings
->Pages
to set the source of the github page togithub-pages
branch root folder andsave
-
with github action, the website will be automatically deployed to github pages when you push to the
main
branch -
visit the website at
https://<username>.github.io/<project_name>
-
in the future the website will be updated automatically via github action after every push to the
main
branch
Local development and deployment
-
nbdev_preview
to preview the website locally -
nbdev_export
to export the the library -
pip install -e .
to install the library in editable mode -
nbdev_pypi
to build the package and upload to pypi
License
- add appropriate license to the project by modifying
LICENSE
file. Instructions can be found here
Happy Coding!
1+1
2
print("Hello World!")
Hello World!
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for hdo_nbdev_template-0.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 722103a207157b56e1cd794f64619dc4dd4a550b0af5a1637afc10b09dad973d |
|
MD5 | b66f52990a2b7d89b75914d6dcec3be0 |
|
BLAKE2b-256 | 71ec0cfe10c91e609f24dddc338838cd47da97d02b386a5cf3c71bc796d5ba54 |