Skip to content

Commit d61ecb1

Browse files
deven367deven367
committed
1 parent 5e99bfa commit d61ecb1

File tree

2 files changed

+56
-58
lines changed

2 files changed

+56
-58
lines changed

‎README.md

Lines changed: 28 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -82,35 +82,34 @@ available commands:
8282
!nbdev_help
8383
```
8484

85-
nbdev_bump_version Increment version in settings.ini by one
86-
nbdev_changelog Create a CHANGELOG.md file from closed and labeled GitHub issues
87-
nbdev_clean Clean all notebooks in `fname` to avoid merge conflicts
88-
nbdev_conda Create a `meta.yaml` file ready to be built into a package, and optionally build and upload it
89-
nbdev_create_config Create a config file.
90-
nbdev_deploy Deploy docs to GitHub Pages
91-
nbdev_docs Create Quarto docs and README.md
92-
nbdev_export Export notebooks in `path` to Python modules
93-
nbdev_filter A notebook filter for Quarto
94-
nbdev_fix Create working notebook from conflicted notebook `nbname`
95-
nbdev_help Show help for all console scripts
96-
nbdev_install Install Quarto and the current library
97-
nbdev_install_hooks Install Jupyter and git hooks to automatically clean, trust, and fix merge conflicts in notebooks
98-
nbdev_install_quarto Install latest Quarto on macOS or Linux, prints instructions for Windows
99-
nbdev_merge Git merge driver for notebooks
100-
nbdev_migrate Convert all directives and callouts in `fname` from v1 to v2
101-
nbdev_new Create an nbdev project.
102-
nbdev_prepare Export, test, and clean notebooks, and render README if needed
103-
nbdev_preview Preview docs locally
104-
nbdev_proc_nbs Process notebooks in `path` for docs rendering
105-
nbdev_pypi Create and upload Python package to PyPI
106-
nbdev_readme None
107-
nbdev_release_both Release both conda and PyPI packages
108-
nbdev_release_gh Calls `nbdev_changelog`, lets you edit the result, then pushes to git and calls `nbdev_release_git`
109-
nbdev_release_git Tag and create a release in GitHub for the current version
110-
nbdev_sidebar Create sidebar.yml
111-
nbdev_test Test in parallel notebooks matching `path`, passing along `flags`
112-
nbdev_trust Trust notebooks matching `fname`
113-
nbdev_update Propagate change in modules matching `fname` to notebooks that created them
85+
nbdev_bump_version Increment version in settings.ini by one
86+
nbdev_changelog Create a CHANGELOG.md file from closed and labeled GitHub issues
87+
nbdev_clean Clean all notebooks in `fname` to avoid merge conflicts
88+
nbdev_conda Create a `meta.yaml` file ready to be built into a package, and optionally build and upload it
89+
nbdev_create_config Create a config file.
90+
nbdev_docs Create Quarto docs and README.md
91+
nbdev_export Export notebooks in `path` to Python modules
92+
nbdev_filter A notebook filter for Quarto
93+
nbdev_fix Create working notebook from conflicted notebook `nbname`
94+
nbdev_help Show help for all console scripts
95+
nbdev_install Install Quarto and the current library
96+
nbdev_install_hooks Install Jupyter and git hooks to automatically clean, trust, and fix merge conflicts in notebooks
97+
nbdev_install_quarto Install latest Quarto on macOS or Linux, prints instructions for Windows
98+
nbdev_merge Git merge driver for notebooks
99+
nbdev_migrate Convert all markdown and notebook files in `path` from v1 to v2
100+
nbdev_new Create an nbdev project.
101+
nbdev_prepare Export, test, and clean notebooks, and render README if needed
102+
nbdev_preview Preview docs locally
103+
nbdev_proc_nbs Process notebooks in `path` for docs rendering
104+
nbdev_pypi Create and upload Python package to PyPI
105+
nbdev_readme Create README.md from readme_nb (index.ipynb by default)
106+
nbdev_release_both Release both conda and PyPI packages
107+
nbdev_release_gh Calls `nbdev_changelog`, lets you edit the result, then pushes to git and calls `nbdev_release_git`
108+
nbdev_release_git Tag and create a release in GitHub for the current version
109+
nbdev_sidebar Create sidebar.yml
110+
nbdev_test Test in parallel notebooks matching `path`, passing along `flags`
111+
nbdev_trust Trust notebooks matching `fname`
112+
nbdev_update Propagate change in modules matching `fname` to notebooks that created them
114113

115114
## FAQ
116115

‎nbs/getting_started.ipynb

Lines changed: 28 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -129,35 +129,34 @@
129129
"name": "stdout",
130130
"output_type": "stream",
131131
"text": [
132-
"\u001b[1m\u001b[94mnbdev_bump_version\u001b[0m Increment version in settings.ini by one\n",
133-
"\u001b[1m\u001b[94mnbdev_changelog\u001b[0m Create a CHANGELOG.md file from closed and labeled GitHub issues\n",
134-
"\u001b[1m\u001b[94mnbdev_clean\u001b[0m Clean all notebooks in `fname` to avoid merge conflicts\n",
135-
"\u001b[1m\u001b[94mnbdev_conda\u001b[0m Create a `meta.yaml` file ready to be built into a package, and optionally build and upload it\n",
136-
"\u001b[1m\u001b[94mnbdev_create_config\u001b[0m Create a config file.\n",
137-
"\u001b[1m\u001b[94mnbdev_deploy\u001b[0m Deploy docs to GitHub Pages\n",
138-
"\u001b[1m\u001b[94mnbdev_docs\u001b[0m Create Quarto docs and README.md\n",
139-
"\u001b[1m\u001b[94mnbdev_export\u001b[0m Export notebooks in `path` to Python modules\n",
140-
"\u001b[1m\u001b[94mnbdev_filter\u001b[0m A notebook filter for Quarto\n",
141-
"\u001b[1m\u001b[94mnbdev_fix\u001b[0m Create working notebook from conflicted notebook `nbname`\n",
142-
"\u001b[1m\u001b[94mnbdev_help\u001b[0m Show help for all console scripts\n",
143-
"\u001b[1m\u001b[94mnbdev_install\u001b[0m Install Quarto and the current library\n",
144-
"\u001b[1m\u001b[94mnbdev_install_hooks\u001b[0m Install Jupyter and git hooks to automatically clean, trust, and fix merge conflicts in notebooks\n",
145-
"\u001b[1m\u001b[94mnbdev_install_quarto\u001b[0m Install latest Quarto on macOS or Linux, prints instructions for Windows\n",
146-
"\u001b[1m\u001b[94mnbdev_merge\u001b[0m Git merge driver for notebooks\n",
147-
"\u001b[1m\u001b[94mnbdev_migrate\u001b[0m Convert all directives and callouts in `fname` from v1 to v2\n",
148-
"\u001b[1m\u001b[94mnbdev_new\u001b[0m Create an nbdev project.\n",
149-
"\u001b[1m\u001b[94mnbdev_prepare\u001b[0m Export, test, and clean notebooks, and render README if needed\n",
150-
"\u001b[1m\u001b[94mnbdev_preview\u001b[0m Preview docs locally\n",
151-
"\u001b[1m\u001b[94mnbdev_proc_nbs\u001b[0m Process notebooks in `path` for docs rendering\n",
152-
"\u001b[1m\u001b[94mnbdev_pypi\u001b[0m Create and upload Python package to PyPI\n",
153-
"\u001b[1m\u001b[94mnbdev_readme\u001b[0m None\n",
154-
"\u001b[1m\u001b[94mnbdev_release_both\u001b[0m Release both conda and PyPI packages\n",
155-
"\u001b[1m\u001b[94mnbdev_release_gh\u001b[0m Calls `nbdev_changelog`, lets you edit the result, then pushes to git and calls `nbdev_release_git`\n",
156-
"\u001b[1m\u001b[94mnbdev_release_git\u001b[0m Tag and create a release in GitHub for the current version\n",
157-
"\u001b[1m\u001b[94mnbdev_sidebar\u001b[0m Create sidebar.yml\n",
158-
"\u001b[1m\u001b[94mnbdev_test\u001b[0m Test in parallel notebooks matching `path`, passing along `flags`\n",
159-
"\u001b[1m\u001b[94mnbdev_trust\u001b[0m Trust notebooks matching `fname`\n",
160-
"\u001b[1m\u001b[94mnbdev_update\u001b[0m Propagate change in modules matching `fname` to notebooks that created them\n"
132+
"\u001b[1m\u001b[94mnbdev_bump_version\u001b[22m\u001b[39m Increment version in settings.ini by one\n",
133+
"\u001b[1m\u001b[94mnbdev_changelog\u001b[22m\u001b[39m Create a CHANGELOG.md file from closed and labeled GitHub issues\n",
134+
"\u001b[1m\u001b[94mnbdev_clean\u001b[22m\u001b[39m Clean all notebooks in `fname` to avoid merge conflicts\n",
135+
"\u001b[1m\u001b[94mnbdev_conda\u001b[22m\u001b[39m Create a `meta.yaml` file ready to be built into a package, and optionally build and upload it\n",
136+
"\u001b[1m\u001b[94mnbdev_create_config\u001b[22m\u001b[39m Create a config file.\n",
137+
"\u001b[1m\u001b[94mnbdev_docs\u001b[22m\u001b[39m Create Quarto docs and README.md\n",
138+
"\u001b[1m\u001b[94mnbdev_export\u001b[22m\u001b[39m Export notebooks in `path` to Python modules\n",
139+
"\u001b[1m\u001b[94mnbdev_filter\u001b[22m\u001b[39m A notebook filter for Quarto\n",
140+
"\u001b[1m\u001b[94mnbdev_fix\u001b[22m\u001b[39m Create working notebook from conflicted notebook `nbname`\n",
141+
"\u001b[1m\u001b[94mnbdev_help\u001b[22m\u001b[39m Show help for all console scripts\n",
142+
"\u001b[1m\u001b[94mnbdev_install\u001b[22m\u001b[39m Install Quarto and the current library\n",
143+
"\u001b[1m\u001b[94mnbdev_install_hooks\u001b[22m\u001b[39m Install Jupyter and git hooks to automatically clean, trust, and fix merge conflicts in notebooks\n",
144+
"\u001b[1m\u001b[94mnbdev_install_quarto\u001b[22m\u001b[39m Install latest Quarto on macOS or Linux, prints instructions for Windows\n",
145+
"\u001b[1m\u001b[94mnbdev_merge\u001b[22m\u001b[39m Git merge driver for notebooks\n",
146+
"\u001b[1m\u001b[94mnbdev_migrate\u001b[22m\u001b[39m Convert all markdown and notebook files in `path` from v1 to v2\n",
147+
"\u001b[1m\u001b[94mnbdev_new\u001b[22m\u001b[39m Create an nbdev project.\n",
148+
"\u001b[1m\u001b[94mnbdev_prepare\u001b[22m\u001b[39m Export, test, and clean notebooks, and render README if needed\n",
149+
"\u001b[1m\u001b[94mnbdev_preview\u001b[22m\u001b[39m Preview docs locally\n",
150+
"\u001b[1m\u001b[94mnbdev_proc_nbs\u001b[22m\u001b[39m Process notebooks in `path` for docs rendering\n",
151+
"\u001b[1m\u001b[94mnbdev_pypi\u001b[22m\u001b[39m Create and upload Python package to PyPI\n",
152+
"\u001b[1m\u001b[94mnbdev_readme\u001b[22m\u001b[39m Create README.md from readme_nb (index.ipynb by default)\n",
153+
"\u001b[1m\u001b[94mnbdev_release_both\u001b[22m\u001b[39m Release both conda and PyPI packages\n",
154+
"\u001b[1m\u001b[94mnbdev_release_gh\u001b[22m\u001b[39m Calls `nbdev_changelog`, lets you edit the result, then pushes to git and calls `nbdev_release_git`\n",
155+
"\u001b[1m\u001b[94mnbdev_release_git\u001b[22m\u001b[39m Tag and create a release in GitHub for the current version\n",
156+
"\u001b[1m\u001b[94mnbdev_sidebar\u001b[22m\u001b[39m Create sidebar.yml\n",
157+
"\u001b[1m\u001b[94mnbdev_test\u001b[22m\u001b[39m Test in parallel notebooks matching `path`, passing along `flags`\n",
158+
"\u001b[1m\u001b[94mnbdev_trust\u001b[22m\u001b[39m Trust notebooks matching `fname`\n",
159+
"\u001b[1m\u001b[94mnbdev_update\u001b[22m\u001b[39m Propagate change in modules matching `fname` to notebooks that created them\n"
161160
]
162161
}
163162
],

0 commit comments

Comments
 (0)