Este tema Sphinx foi projetado para fornecer uma ótima experiência de leitura para usuários de documentação em desktops e dispositivos móveis. Este tema é usado principalmente no Read the Docs, mas pode funcionar com qualquer projeto Sphinx. Você pode encontrar uma demonstração funcional do tema na documentação do tema
Este tema é distribuído no PyPI e pode ser instalado com pip
:
$ pip instalar tema esfinge-rtd
Para usar o tema em seu projeto Sphinx, você precisará editar a configuração html_theme
do seu arquivo conf.py
:
html_theme = "sphinx_rtd_theme"
Veja também:
Navegadores suportados
Combinações de navegador/sistema operacional oficialmente suportadas e testadas
Dependências suportadas
Versões suportadas de Python, Sphinx e outras dependências.
Documentação de exemplo
Um exemplo completo da saída deste tema, com strings localizadas habilitadas.
Este tema é altamente personalizável tanto no nível da página quanto no nível global. Para ver todas as opções de configuração possíveis, leia a documentação de configuração do tema.
Se quiser ajudar a modificar ou traduzir o tema, você encontrará mais informações sobre como contribuir em nosso guia de contribuição.