AnswerDotAI / AnswerDotAI/nbdev
Unwanted `show_doc` Documentation Automatically Added 3x to Rendered HTML
- Vorherrschende Sprache
- Jupyter Notebook
- Sterne
- 5.3k
- Forks
- 513
- Ø Merge
- 2 T. 30 Min.
- Gemergte PRs (30 T.)
- 8
Beschreibung
## Description
When using nbdev to write a Python package, I've encountered an issue possibly associated with the `nbdev_export` command:
- Running `nbdev_preview` to check the rendered HTML version of my source code for documentation results in the documentation for `show_doc` being automatically added three times to the very end of the rendered HTML page. The same is true for the published page with source code on GitHub pages
- This occurs even though the built-in nbdev `show_doc` function has not been imported or used in the Jupyter notebook containing my source code (named `01_code.ipynb`, following the nbdev documentation).
- The markdown for `show_doc` appears in the local markdown file `_proc/_docs/core.html.md` located in my project's root directory and in the published page on GitHub pages:
## Current Behavior
The `show_doc` documentation is automatically added three times to the end of the rendered HTML and markdown files.
## Expected Behavior
The rendered HTML and markdown files should only contain documentation for the code actually present in the source notebook.
## Attempted Solutions
- Ran `nbdev_clean` (no effect on this issue).
- Re-ran `nbdev_export` (doesn't fix the issue).
- All tests run successfully with `nbdev_test`.
- Ensured no mixing of import statements with actual code (known to cause issues with nbdev).
Any suggestions to fix this would be greatly appreciated. Thank you!
Beitragsleitfaden
Rechercherichtung
Reproduziere das Problem mit nbdev_preview unter Verwendung des Notebooks 01_code.ipynb und untersuche anschließend die generierte Datei _proc/_docs/core.html.md auf die wiederholten show_doc-Einträge. Vergleiche den generierten Inhalt mit dem Notebook und führe nbdev_clean, nbdev_export und nbdev_test aus, um festzustellen, ob die doppelte Dokumentation während des Exports oder des Renderings erzeugt wird.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- jupyter, python
- Bereich
- devtools, documentation
- Issue-Typ
- Bug
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100