AnswerDotAI / AnswerDotAI/nbdev

Cross reference on nbdev

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

Beschreibung

Quarto [cross referencing](https://quarto.org/docs/authoring/cross-references.html#code-listings) is very uselful when generating docs. I was able to use this feature with nbdev by using raw cells.

It would awesome to have a nbdev directive to reference a code cell in a markdown cell, for example:

![Screenshot from 2022-12-16 13-45-32](https://user-images.githubusercontent.com/6730205/208147811-a4509a8f-bf21-4210-9ab8-809dcaad70ed.png)

Right now I'm using Quarto syntax on nbdev raw cells containing python code (see images below) but it can be a little limited since I can't test the code used on the raw cell.

![Screenshot from 2022-12-16 13-50-57](https://user-images.githubusercontent.com/6730205/208148572-f37f9dfb-94f2-4f92-9785-455a536dd563.png)

![Screenshot from 2022-12-16 13-51-03](https://user-images.githubusercontent.com/6730205/208148798-a7d52395-bbe1-464b-9600-3aaa002f260e.png)

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Das Issue nennt keinen Datei- oder Test-Einstiegspunkt. Beginne damit zu prüfen, wie nbdev mit Raw-Zellen umgeht und welche Hinweise zu Quarto-Querverweisen verlinkt sind; abgeschlossen ist die Aufgabe, wenn eine nbdev-Direktive von einer Markdown-Zelle aus auf eine Code-Zelle verweisen kann, ohne auf eine nicht testbare Raw-Zelle angewiesen zu sein.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
jupyter, python
Bereich
documentation
Issue-Typ
Feature
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

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