AnswerDotAI / AnswerDotAI/nbdev

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

Offen
#1,492 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

bug
Vorherrschende Sprache
Jupyter Notebook
Sterne
5.3k
Forks
514
Ø Merge
2 T. 30 Min.
Gemergte PRs (30 T.)
8

Beschreibung

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.

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

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.

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Reproduziere das Problem mit nbdev_init, einem nbs/00_test-Verzeichnis und nbdev_preview. Vergleiche den generierten sidebar.yml-Pfad mit dem generierten _proc/00_test/00_core.html.md-Pfad; abgeschlossen bedeutet, dass führende Ziffern erhalten bleiben, sodass der Preview-Link korrekt aufgelöst wird.

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
Größtenteils klar
Anfängerfreundlichkeit
52/100

Neue Issues direkt in Ihr Postfach

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