Hacktoberfest 2026: as issues que os mantenedores marcaram para outubro, abertas e boas para iniciantes. Ver issues do Hacktoberfest

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

Aberta
  • Algo errado?
#1,446 1 comentário 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
3/5
Tempo estimado
1-2 dias
Facilidade para iniciantes
35/100
Tipo de issue
Bug
Clareza
Razoavelmente clara
Status de atividade
Estagnada
Stack de tecnologia
jupyter, python
Domínio
devtools, documentation

Direção de pesquisa

Reproduza o problema com nbdev_preview usando o notebook 01_code.ipynb e, em seguida, inspecione o arquivo _proc/_docs/core.html.md gerado em busca das entradas show_doc repetidas. Compare o conteúdo gerado com o notebook e execute nbdev_clean, nbdev_export e nbdev_test para identificar se a documentação duplicada é produzida durante a exportação ou a renderização.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

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!

Linguagem predominante
Jupyter Notebook
Estrelas
5.3k
Forks
518
Merge médio
1d 3h
PRs com merge (30d)
2

Preparar o ambiente

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de AnswerDotAI/nbdev

Todas as issues de AnswerDotAI/nbdev

Issues semelhantes

Mais issues de DevTools

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.