AnswerDotAI / AnswerDotAI/nbdev

nbdev_preview strips leading digits from directories in `sidebar.yml`, but not in `_docs`

Aperta
#1,492 0 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

As the title suggests, calling `nbdev_preview` with a file inside a directory whose name starts with leading digits (e.g. `00_test`) will result in broken documentation.

## steps to reproduce
Create a new nbdev_project and a `00_test` directory under notebooks.

```bash
nbdev_init
mkdir nbs/00_test
mv nbs/00_core.ipynb nbs/00_test/00_core.ipynb
nbdev_preview
```

will result in the following `sidebar.yml`

```yaml
website:
sidebar:
contents:
- index.ipynb
- section: test
contents:
- test/00_core.ipynb
```

which is broken, as the correct path would be `00_test/00_core.ipynb` (file is under `_proc/00_test/00_core.html.md`). Thus the link in the preview will not work.

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Riproduci il problema con nbdev_init, una directory nbs/00_test e nbdev_preview. Confronta il percorso sidebar.yml generato con il percorso _proc/00_test/00_core.html.md generato; completato significa che le cifre iniziali vengono preservate, così che il link di anteprima venga risolto correttamente.

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
Abbastanza chiara
Idoneità per principianti
52/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.