AnswerDotAI / AnswerDotAI/nbdev

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

Aperta
#1,329 3 commenti 0 reazioni 0 assegnatari Vedi su GitHub
bug
Lingua principale
Jupyter Notebook
Stelle
5.3k
Fork
513
Merge medio
2g 30m
PR unite (30g)
8

Descrizione

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!

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Inizia con il comando nbdev_readme e la struttura del repository descritta nell’issue, in particolare settings.ini, nbs/index.ipynb, _proc/docs/README.md e il README.md nella root. Esegui il comando per riprodurre quale file cambia, quindi determina la destinazione prevista del README e documenta o testa il comportamento che lo aggiorna in modo coerente.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
jupyter-notebook, python
Ambito
documentation, tooling
Tipo di issue
Bug
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Ferma
Chiarezza
Da chiarire
Idoneità per principianti
34/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.