SphinxMinooTheme

Minoo

Le thème Minoo est un thème Sphinx qui prend en charge les langues de droite à gauche comme le persan. Il est disponible sur PYPI et permet aux développeurs de créer des sites Web de documentation avec une conception élégante et fonctionnelle qui fonctionne bien avec les langues RTL.

Contenu

• Caractéristiques
• Installation
  • Via un paquet
  • Via git ou télécharger
• Personnalisation
• Licence
• Gratitude

Caractéristiques

• Couleurs de matériau
• Support de langue RTL
• Conception réactive
• Intégration Google Analytics
• Liens sociaux et avatar
• GRATUIT à utiliser

Installation

Via un paquet

Vous pouvez installer le thème Minoo à partir de PYPI:

 $ pip install sphinx_minoo_theme

Pour utiliser le thème de votre projet Sphinx, modifiez votre fichier de configuration Sphinx conf.py comme suit:

 # En haut.
importer sphinx_minoo_theme

# ...

extensions = ["sphinxContrib.jquery"]
html_theme = "sphinx_minoo_theme"
html_theme_path = [sphinx_minoo_theme.get_html_theme_path ()]

Via git ou télécharger

Alternativement, vous pouvez télécharger le thème à partir du référentiel et copier sphinx_minoo_theme/sphinx_minoo_theme dans votre documentation dans le dossier _templates . Ensuite, ajoutez les lignes suivantes à votre fichier conf.py :

 extensions = ["sphinxContrib.jquery"]
html_theme = "sphinx_minoo_theme"
html_theme_path = ["_Templates"]

Personnalisation

Pour personnaliser le thème Minoo, suivez ces étapes:

1. Mettez votre fichier d'image Avatar dans le dossier static avec le nom avatar.jpg .
2. Modifier le fichier de configuration du thème theme.conf :

• Changer la direction:

   direction = ltr
  

  Pour les langues "droite à gauche", définissez-la sur rtl

• Ajoutez votre identifiant Google Analytics:

   analytics_id = ua-xxxxx-x
  

• Ajoutez l'adresse de votre site Web et les liens sociaux:

   site Web =
  Facebook =
  googleplus =
  LinkedIn =
  twitter =
  github = https://github.com/saeiddrv/sphinxminoothememe
  gitlab =
  bitbucket =
  

  Laissez vide ce que vous ne voulez pas.

3. Modifiez le fichier glossary.html pour modifier les mots du thème.

Licence

Le thème de Minoo est sous licence MIT. Pour plus d'informations, consultez le fichier de licence.

Gratitude

Je tiens à remercier sphinx_rtd_theme de m'avoir aidé à construire ce thème.