Hacktoberfest 2026 : les issues que les mainteneurs ont marquées pour octobre, ouvertes et accessibles aux débutants. Parcourir les issues Hacktoberfest

Unwanted `show_doc` Documentation Automatically Added 3x to Rendered HTML

Ouverte
  • Quelque chose ne va pas ?
#1,446 1 commentaire 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
3/5
Temps estimé
1-2 jours
Accessibilité débutants
35/100
Type d'issue
Bug
Clarté
Plutôt claire
Activité
À l'abandon
Stack technique
jupyter, python
Domaine
devtools, documentation

Piste de recherche

Reproduisez le problème avec nbdev_preview en utilisant le notebook 01_code.ipynb, puis examinez le fichier _proc/_docs/core.html.md généré à la recherche des entrées show_doc répétées. Comparez le contenu généré avec le notebook et exécutez nbdev_clean, nbdev_export et nbdev_test afin de déterminer si la documentation en double est produite pendant l’exportation ou le rendu.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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!

Langage dominant
Jupyter Notebook
Étoiles
5.3k
Forks
518
Merge moyen
1 j 3 h
PR mergées (30 j)
2

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de AnswerDotAI/nbdev

Toutes les issues de AnswerDotAI/nbdev

Issues similaires

Plus d'issues DevTools

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.