sphinx-doc/sphinx

Theme developers should be able to configure sphinx to trigger rebuilds based on theme changes

Open

#2.835 geöffnet am 8. Aug. 2016

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Python (1.985 Forks)batch import
builder:htmlgood first issuehelp wantedhtml theme

Repository-Metriken

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

Beschreibung

If I am editing a theme, Sphinx does not trigger rebuilds based on theme changes; I have to do make clean and make html again, which can take quite a bit of time for a large document tree.

It would be helpful if, while editing theme elements, if I could configure Sphinx in a mode where it would "do the right thing":

  • if just .css and static elements have changed, then just copy these files to the build output
  • if theme templates have changed, then all the output files need to be re-rendered

see http://stackoverflow.com/questions/38794431/how-to-use-sphinx-build-when-developing-a-theme-sphinx-doesnt-seem-to-recogni

Contributor Guide

Research-Richtung
Das Issue fordert, dass Sphinx automatisch neu baut, wenn sich Theme Dateien (CSS, statische Dateien, Templates) ändern, anstatt einen vollständigen Clean Build zu erfordern. Zur Implementierung müsste der Dateiüberwachungsmechanismus des Sphinx Builders untersucht werden, wahrscheinlich im Modul sphinx.builders, und Konfigurationsoptionen für Theme Entwickler hinzugefügt werden, um anzugeben, welche Dateitypen einen vollständigen Neuaufbau im Gegensatz zu einem Kopiervorgang auslösen sollten. Das bestehende Verhalten kann über sphinx build mit dem W Flag beobachtet werden; das Ziel ist es, eine inkrementelle Neubau Logik ähnlich wie bei anderen statischen Site Generatoren hinzuzufügen.
Tech Stack
python
Domain
documentationbackenddeveloper experience
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
3-5 Tage
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.
Klar
Voraussetzungen
PythonSphinx
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
65