AnswerDotAI / AnswerDotAI/nbdev

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

Open
#1,329 3 comments 0 reactions 0 assignees View on GitHub
bug
Dominant language
Jupyter Notebook
Stars
5.3k
Forks
513
Avg merge
2d 30m
Merged PRs (30d)
8

Description

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](https://user-images.githubusercontent.com/25931612/232733059-ed57c28a-632b-4d09-abe7-8bdadf914ebb.png)

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

Thanks!

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.