fastai / nbdev

Create delightful software with Jupyter Notebooks
https://nbdev.fast.ai/
Apache License 2.0
4.93k stars 488 forks source link

Describe file structure created by `nbdev_new` #960

Open seeM opened 2 years ago

seeM commented 2 years ago

Inspired by VSCode's extensions docs:

image

Here's the structure created by nbdev_new as of writing:

$ tree -a -I .git -I .quarto
.
├── .github
│   └── workflows
│       ├── deploy.yaml
│       └── test.yaml
├── .gitignore
├── 00_core.ipynb
├── LICENSE
├── MANIFEST.in
├── README.md
├── _docs
│   ├── robots.txt
│   └── sitemap.xml
├── _quarto.yml
├── index.ipynb
├── settings.ini
├── setup.py
├── styles.css
└── {lib_path}
    ├── __init__.py
    ├── _modidx.py
    └── core.py
tylere commented 2 years ago

This could be even more useful if it was expanded to other commands beyond nbdev_new, and it would useful to know what files each nbdev_* command expects to be in place when it runs, and what files are created/modified when the command runs.

Examples of specific questions this could answer: