AnswerDotAI / AnswerDotAI/nbdev

Cross reference on nbdev

Open
#1,245 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Jupyter Notebook
Stars
5.3k
Forks
513
Avg merge
2d 30m
Merged PRs (30d)
8

Description

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)

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.