AnswerDotAI / AnswerDotAI/nbdev

notebooks with auto in their name are skipped in doclinks

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

Description

# Provide a minimally reproducible example

#1428 changed the following line

https://github.com/AnswerDotAI/nbdev/blob/8095d12c260dd7cc5d8c2ca34e89819c58fd679a/nbdev/doclinks.py#L74

to

https://github.com/AnswerDotAI/nbdev/blob/ea935f5cb6adf3f1206dc55f3b6256a7ec3e14a7/nbdev/doclinks.py#L80

which makes `nbdev_export` remove all the syms in `_modidx.py` for a notebook that has `auto` in its name, see for example the following PRs:

* https://github.com/Nixtla/mlforecast/pull/392/commits/4df35c74e86937fd9c2c5e973ed95ef894dfb001
* https://github.com/Nixtla/neuralforecast/pull/1085/commits/02db6808510d88913d2bd04abed8a3930766afa4

Contributor guide

Open the contributing guide

Research direction

Start in nbdev/doclinks.py at the referenced line and compare the changes from #1428; reproduce the issue with a notebook whose name contains `auto` and run `nbdev_export`. Done means `_modidx.py` retains that notebook's symbols instead of removing them, as shown by the linked mlforecast and neuralforecast commits.

Written by the indexing model from the issue text.

Assessment

Tech stack
jupyter-notebook, python
Domain
documentation, tooling
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.