AnswerDotAI / AnswerDotAI/nbdev

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

Offen
#1,329 3 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
bug
Vorherrschende Sprache
Jupyter Notebook
Sterne
5.3k
Forks
513
Ø Merge
2 T. 30 Min.
Gemergte PRs (30 T.)
8

Beschreibung

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!

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Beginne mit dem nbdev_readme command und der im Issue beschriebenen Repository-Struktur, insbesondere settings.ini, nbs/index.ipynb, _proc/docs/README.md und README.md im Stammverzeichnis. Führe den command aus, um zu reproduzieren, welche Datei geändert wird, ermittle dann das vorgesehene README-Ziel und dokumentiere oder teste das Verhalten, das es konsistent aktualisiert.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
jupyter-notebook, python
Bereich
documentation, tooling
Issue-Typ
Bug
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
34/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.