AnswerDotAI / AnswerDotAI/nbdev

Cross reference on nbdev

Abierto
#1,245 0 comentarios 0 reacciones 0 asignados Ver en GitHub
Lenguaje dominante
Jupyter Notebook
Estrellas
5.3k
Forks
514
Merge medio
2 d 30 min
PR fusionados (30 d)
8

Descripción

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)

Guía de contribución

Abrir la guía de contribución

Línea de trabajo

El issue no proporciona ningún punto de entrada de archivo o de prueba. Empieza revisando cómo nbdev gestiona las celdas raw y la guía enlazada de referencias cruzadas de Quarto; el trabajo estará terminado cuando una directiva de nbdev pueda hacer referencia a una celda de código desde una celda Markdown sin depender de una celda raw que no se pueda probar.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
jupyter, python
Área
documentation
Tipo de issue
Nueva funcionalidad
Dificultad
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
35/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.