sphinx-doc/sphinx

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

Open

#2.835 aberto em 8 de ago. de 2016

Ver no GitHub
 (0 comments) (0 reactions) (0 assignees)Python (1.985 forks)batch import
builder:htmlgood first issuehelp wantedhtml theme

Métricas do repositório

Stars
 (5.625 stars)
Métricas de merge de PR
 (Mesclagem média 10d 11h) (11 fundiu PRs em 30d)

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

Guia do colaborador

Direção de pesquisa
A issue solicita que o Sphinx reconstrua automaticamente quando os arquivos do tema (CSS, estáticos, templates) mudam, em vez de exigir uma build completa limpa. Para implementar, seria necessário explorar o mecanismo de monitoramento de arquivos do construtor do Sphinx, provavelmente no módulo sphinx.builders, e adicionar opções de configuração para desenvolvedores de temas especificarem quais tipos de arquivo devem acionar uma reconstrução completa versus uma simples cópia. O comportamento existente pode ser observado via sphinx build com a flag W; o objetivo é adicionar lógica de reconstrução incremental semelhante a outros geradores de sites estáticos.
Pilha de tecnologia
python
Domain
documentationbackenddeveloper experience
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
3-5 dias
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Antigo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
PythonSphinx
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
65