nbdev icon indicating copy to clipboard operation
nbdev copied to clipboard

nbdev_readme only generates README in `docs` folder and not in main folder

Open gorkamunoz opened this issue 2 years ago • 3 comments

Hi, I am using the nbdev_readme command to generate the README file from index.ipynb. My repo looks as following (simplified):

.
├── nbs/ 
│   └── index.ipynb     
├── _proc/
│   └── docs/
│       └── README.md
├──  settings.ini
├──  setup.py
└──  README.md

The problem I encounter is that when running nbdev_readme, only the README.md from _proc/docs/ is updated, and not the one in the main folder. This is what I get as terminal output:

image

I am doing something wrong or is this intended? What can I change to have the automatic README update from the main folder?

Thanks!

gorkamunoz avatar Apr 18 '23 09:04 gorkamunoz

@gorkamunoz It is intended functionality. The nbdev_readme command should also update the readme at the root level of your repo.

deven367 avatar Nov 13 '23 02:11 deven367