sphinx-doc/sphinx

Cannot recover from MemoryErrors

Geschlossen

#7.635 geöffnet am 08.05.2020

Auf GitHub ansehenContributor Guide
 (2 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Python (1.985 Forks)batch import
help wantedtype:bug

Repository-Metriken

Stars
 (5.625 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 10T 11h) (11 gemergte PRs in 30 T)

Beschreibung

We are using recommonmark with sphinx to parse 2.3k+ md files and experiencing excesive memory usage. Running 64 bit we see a peak of about 19gb of memory usage and an execution time around 30 minutes. On many machines (or running 32 bit) this is not doable. The majority of the markdown files have an rst label, and some of them have references to these labels. Are there configuration options that may be affecting this? Is there a way to review what's actually taking up this memory?

Contributor Guide

Research-Richtung
Investigate memory usage during parsing of many markdown files with recommonmark. Use memory profiler or tracemalloc to identify peak memory allocations. Compare with direct Python memory usage and explore Sphinx's handling of large document sets. Look at recommonmark's parser and Sphinx's build process in sphinx/builders/ for potential optimizations or configuration options to reduce memory footprint.
Tech Stack
python
Domain
documentationperformance
Issue Type
Fehler
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
4
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Über 1 Woche
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Veraltet
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Recherche nötig
Voraussetzungen
PythonMemory profilingSphinx internalsCPython debugging
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
10