sphinx-doc/sphinx

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

Open

#2835 aperta il 8 ago 2016

Vedi su GitHub
 (0 commenti) (0 reazioni) (0 assegnatari)Python (1985 fork)batch import
builder:htmlgood first issuehelp wantedhtml theme

Metriche repository

Star
 (5625 star)
Metriche merge PR
 (Merge medio 10g 11h) (11 PR mergiate in 30 g)

Descrizione

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

Guida contributor

Direzione di ricerca
La segnalazione richiede che Sphinx ricostruisca automaticamente quando i file del tema (CSS, statici, template) cambiano, invece di richiedere una build completa pulita. Per implementarlo, bisognerebbe esplorare il meccanismo di monitoraggio dei file del builder di Sphinx, probabilmente nel modulo sphinx.builders, e aggiungere opzioni di configurazione per gli sviluppatori di temi per specificare quali tipi di file dovrebbero attivare una ricostruzione completa rispetto a una semplice copia. Il comportamento esistente può essere osservato tramite sphinx build con il flag W; l'obiettivo è aggiungere una logica di ricostruzione incrementale simile ad altri generatori di siti statici.
Tech stack
python
Dominio
documentationbackenddeveloper experience
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
3-5 giorni
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Datata
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
PythonSphinx
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
65