SphinxMinooTheme

Minoo

O tema Minoo é um tema de esfinge que suporta idiomas da direita para a esquerda como o persa. Está disponível no Pypi e permite que os desenvolvedores criem sites de documentação com um design elegante e funcional que funciona bem com os idiomas RTL.

Conteúdo

• Características
• Instalação
  • Via pacote
  • Via git ou download
• Personalização
• Licença
• Gratidão

Características

• Cores do material
• Suporte à linguagem RTL
• Design responsivo
• Integração do Google Analytics
• Links sociais e avatar
• Livre para usar

Instalação

Via pacote

Você pode instalar o tema Minoo da Pypi:

 $ pip install sphinx_minoo_theme

Para usar o tema no seu projeto Sphinx, edite seu arquivo de configuração da Esfinge conf.py da seguinte forma:

 # No topo.
Importar SPHINX_MINOO_THEME

# ...

Extensões = ["sphinxContrib.jQuery"]
html_theme = "sphinx_minoo_theme"
html_theme_path = [sphinx_minoo_theme.get_html_theme_path ()]

Via git ou download

Como alternativa, você pode baixar o tema do repositório e copiar sphinx_minoo_theme/sphinx_minoo_theme em sua documentação na pasta _templates . Em seguida, adicione as seguintes linhas ao seu arquivo conf.py :

 Extensões = ["sphinxContrib.jQuery"]
html_theme = "sphinx_minoo_theme"
html_theme_path = ["_templates"]

Personalização

Para personalizar o tema Minoo, siga estas etapas:

1. Coloque seu arquivo de imagem Avatar na pasta static com o nome avatar.jpg .
2. Edite o tema do arquivo de configuração theme.conf :

• Mude a direção:

   direção = ltr
  

  Para idiomas "direito para a esquerda", defina-o como rtl

• Adicione seu ID do Google Analytics:

   Analytics_id = UA-XXXXX-X
  

• Adicione o endereço do seu site e os links sociais:

   site =
  Facebook =
  googlePlus =
  LinkedIn =
  Twitter =
  github = https://github.com/saeiddrv/sphinxMinootheme
  gitlab =
  bitbucket =
  

  Deixe vazio o que não quiser.

3. Edite o arquivo glossary.html para alterar as palavras -temas.

Licença

O tema Minoo está licenciado sob a licença do MIT. Para mais informações, consulte o arquivo de licença.

Gratidão

Gostaria de agradecer a Sphinx_RTD_THEME por me ajudar a construir esse tema.