Unwanted `show_doc` Documentation Automatically Added 3x to Rendered HTML
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Aptitud para principiantes
- 35/100
- Tipo de issue
- Error
- Claridad
- Bastante claro
- Estado de actividad
- Estancado
- Stack tecnológico
- jupyter, python
- Área
- devtools, documentation
Línea de trabajo
Reproduce el problema con nbdev_preview usando el notebook 01_code.ipynb y, a continuación, inspecciona el archivo _proc/_docs/core.html.md generado en busca de las entradas show_doc repetidas. Compara el contenido generado con el notebook y ejecuta nbdev_clean, nbdev_export y nbdev_test para identificar si la documentación duplicada se produce durante la exportación o el renderizado.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Description
When using nbdev to write a Python package, I've encountered an issue possibly associated with the nbdev_export command:
- Running
nbdev_previewto check the rendered HTML version of my source code for documentation results in the documentation forshow_docbeing 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_docfunction has not been imported or used in the Jupyter notebook containing my source code (named01_code.ipynb, following the nbdev documentation). - The markdown for
show_docappears in the local markdown file_proc/_docs/core.html.mdlocated 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!
- Lenguaje dominante
- Jupyter Notebook
- Estrellas
- 5.3k
- Forks
- 517
- Merge medio
- 1 min
- PR fusionados (30 d)
- 3
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Sin plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de AnswerDotAI/nbdev
-
Bug Report: `nbdev` Parser `IndexError` on `@patch_to` with Keyword ArgumentsPosiblemente ocupada @ruchi-mish90 la tomó hace 85 días. Abiertobug
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
AnswerDotAI/nbdev#1596 · 1 comentario ·
-
`great-docs` by Posit Is here!Abierto
Dificultad 5/5 Más de una semana Aptitud para principiantes 25/100
AnswerDotAI/nbdev#1587 ·
-
Interested in Windows support?Posiblemente ocupada @mrexodia la tomó hace 9 días. Abierto
Dificultad 4/5 3-5 días Aptitud para principiantes 35/100
AnswerDotAI/nbdev#1584 · 1 comentario ·
-
Dificultad 3/5 1-2 días Aptitud para principiantes 35/100
AnswerDotAI/nbdev#1583 · 1 comentario · 1 reacción ·
-
bug
Dificultad 3/5 1-2 días Aptitud para principiantes 52/100
AnswerDotAI/nbdev#1581 ·
Todos los issues de AnswerDotAI/nbdev
Issues similares
-
Dependencies view: `getParent` loops forever on untitled documents, extension host runs out of memoryPosiblemente ocupada Un pull request vinculado a esta issue está abierto o ya se fusionó. Abiertobug
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
aicell-lab/bioengine#232 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
zerocracy/judges-action#2729 ·
Los mantenedores suelen responder en 8 días
-
agent/scanner bug hive/hosted-available-lke648397-260827-5n31
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
jbaruch/speaker-toolkit#480 ·
Los mantenedores suelen responder en 1 día