AnswerDotAI / AnswerDotAI/nbdev

Cross reference on nbdev

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

Descrizione

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)

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

L’issue non fornisce alcun punto di ingresso per file o test. Inizia esaminando come nbdev gestisce le celle raw e la guida collegata sui riferimenti incrociati di Quarto; il lavoro è completato quando una direttiva nbdev può fare riferimento a una cella di codice da una cella Markdown senza dipendere da una cella raw non testabile.

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

Valutazione

Stack tecnologico
jupyter, python
Ambito
documentation
Tipo di issue
Funzionalità
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.