SphinxMinooTheme

Minoo

El tema de Minoo es un tema Sphinx que admite idiomas de derecha a izquierda como Persian. Está disponible en PYPI y permite a los desarrolladores crear sitios web de documentación con un diseño elegante y funcional que funcione bien con los idiomas RTL.

Contenido

• Características
• Instalación
  • A través del paquete
  • A través de git o descargar
• Personalización
• Licencia
• Gratitud

Características

• Colores de material
• Soporte de idiomas RTL
• Diseño receptivo
• Integración de Google Analytics
• Enlaces sociales y avatar
• Gratis para usar

Instalación

A través del paquete

Puede instalar el tema Minoo de Pypi:

 $ Pip Install Sphinx_Minoo_Theme

Para usar el tema en su proyecto Sphinx, edite su archivo de configuración Sphinx conf.py de la siguiente manera:

 # En la parte superior.
importar sphinx_mino_theme

# ...

Extensiones = ["SphinxContrib.jquery"]
html_theme = "sphinx_minoo_theme"
html_theme_path = [sphinx_minoo_theme.get_html_theme_path ()]

A través de git o descargar

Alternativamente, puede descargar el tema del repositorio y copiar sphinx_minoo_theme/sphinx_minoo_theme en su documentación en la carpeta _templates . Luego, agregue las siguientes líneas a su archivo conf.py :

 Extensiones = ["SphinxContrib.jquery"]
html_theme = "sphinx_minoo_theme"
html_theme_path = ["_templates"]

Personalización

Para personalizar el tema de Minoo, siga estos pasos:

1. Coloque su archivo de imagen de avatar en la carpeta static con el nombre avatar.jpg .
2. Editar el archivo de configuración del tema theme.conf :

• Dirección de cambio:

   dirección = LTR
  

  Para idiomas de "derecha a izquierda", configúrelo en rtl

• Agregue su ID de Google Analytics:

   Analytics_id = ua-xxxxx-x
  

• Agregue la dirección de su sitio web y los enlaces sociales:

   Sitio web =
  Facebook =
  GooglePlus =
  LinkedIn =
  Twitter =
  github = https://github.com/saeiddrv/sphinxminootheme
  gitlab =
  bitbucket =
  

  Deja vacío lo que no quieras.

3. Edite el archivo glossary.html para cambiar las palabras del tema.

Licencia

El tema de Minoo tiene licencia bajo la licencia MIT. Para obtener más información, consulte el archivo de licencia.

Gratitud

Me gustaría agradecer a SphinX_RTD_THEME por ayudarme a construir este tema.