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

[gorkamunoz]

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:

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

Thanks!

[deven367]

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

[gorkamunoz]

Hi, nbdev_reame does the same thing and only updates the readme in the docs...

[gorkamunoz]

I found where the bug is. In settings.ini, as gotten from the nbdev-template repo, the path to docs is set as doc_path = _docs. When changing this to doc_path = docs (no underscore), everything works as intended...