sphinx-doc/sphinx

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

Open

#2 835 ouverte le 8 août 2016

Voir sur GitHub
 (0 commentaires) (0 réactions) (0 assignés)Python (1 985 forks)batch import
builder:htmlgood first issuehelp wantedhtml theme

Métriques du dépôt

Stars
 (5 625 stars)
Métriques de merge PR
 (Merge moyen 10j 11h) (11 PRs mergées en 30 j)

Description

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

Guide contributeur

Direction de recherche
Le ticket demande que Sphinx reconstruise automatiquement lorsque les fichiers du thème (CSS, statiques, templates) changent, au lieu de nécessiter une reconstruction complète propre. Pour implémenter cela, il faudrait explorer le mécanisme de surveillance des fichiers du constructeur de Sphinx, probablement dans le module sphinx.builders, et ajouter des options de configuration pour que les développeurs de thèmes puissent spécifier quels types de fichiers doivent déclencher une reconstruction complète par rapport à une simple copie. Le comportement existant peut être observé via sphinx build avec l'option W ; l'objectif est d'ajouter une logique de reconstruction incrémentielle similaire à celle d'autres générateurs de sites statiques.
Stack technique
python
Domaine
documentationbackenddeveloper experience
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
3-5 jours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Ancienne
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
PythonSphinx
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
65