sphinx-doc/sphinx-autobuild

O que é?

Recursos principais

• 01Recompila automaticamente a documentação do Sphinx quando arquivos no diretório de origem mudam.
• 02Atualiza as janelas do navegador abertas após cada compilação.
• 03Aceita todos os argumentos de sphinx-build e adiciona opções de servidor e monitoramento.
• 04Oferece suporte a padrões de exclusão glob e regex para os arquivos monitorados.
• 05Executa comandos personalizados antes e depois de cada compilação.
• 06Pode selecionar automaticamente uma porta livre e abrir o navegador na inicialização.

Casos de uso

• Escrever e visualizar a documentação de um projeto com feedback imediato.
• Desenvolver um tema HTML personalizado para o Sphinx enquanto monitora os arquivos do tema.
• Executar vários projetos de documentação ao mesmo tempo, com portas e diretórios de saída separados.
• Enviar notificações de início e conclusão da compilação usando hooks anteriores e posteriores à compilação.

Início rápido

1. 1

   Instale sphinx-autobuild do PyPI com pip

   pip install sphinx-autobuild
2. 2

   Inicie o servidor e monitore as alterações no diretório docs

   sphinx-autobuild docs docs/_build/html

Antes de usar

• !É necessário ter um projeto de documentação Sphinx para que seja útil.

Em coleções

Tópicos

Perguntas frequentes

O que é sphinx-autobuild?

Ferramenta de linha de comando que monitora um diretório de documentação Sphinx, recompila os docs quando há alterações e atualiza o navegador por meio de um servidor local. sphinx-autobuild monitora um diretório de origem do Sphinx e executa sphinx-build sempre que um arquivo muda. Ele serve o HTML gerado em um servidor web local, em http://127.0.0.1:8000 por padrão, e as janelas do navegador abertas recarregam automaticamente após cada compilação. Assim, quem escreve a documentação pode ver as alterações sem precisar recompilar ou atualizar a página manualmente.

sphinx-autobuild é gratuito? Qual é a licença?

sphinx-autobuild é open source sob a licença MIT. Confira os termos da licença antes de usá-lo em produtos comerciais.

sphinx-autobuild ainda é mantido?

Manutenção ativa. O último commit de sphinx-autobuild foi em 23 de out. de 2026.

Para que posso usar sphinx-autobuild?

Escrever e visualizar a documentação de um projeto com feedback imediato. Desenvolver um tema HTML personalizado para o Sphinx enquanto monitora os arquivos do tema. Executar vários projetos de documentação ao mesmo tempo, com portas e diretórios de saída separados. Enviar notificações de início e conclusão da compilação usando hooks anteriores e posteriores à compilação.

Como instalar sphinx-autobuild?

Instale sphinx-autobuild do PyPI com pip: pip install sphinx-autobuild Inicie o servidor e monitore as alterações no diretório docs: sphinx-autobuild docs docs/_build/html

Onde consigo sphinx-autobuild?

O código-fonte e as instruções de instalação estão no GitHub: https://github.com/sphinx-doc/sphinx-autobuild