SphinxMinooTheme

Minoo

Minoo-Thema ist ein Sphinx-Thema, das Recht zu links wie Persisch unterstützt. Es ist auf PYPI verfügbar und ermöglicht Entwicklern, Dokumentations -Websites mit einem eleganten und funktionalen Design zu erstellen, das gut zu RTL -Sprachen passt.

Inhalt

• Merkmale
• Installation
  • Per Paket
  • Über Git oder Download
• Anpassung
• Lizenz
• Dankbarkeit

Merkmale

• Materialfarben
• RTL -Sprachunterstützung
• Responsive Design
• Integration von Google Analytics
• Soziale Links und Avatar
• Frei zu bedienen

Installation

Per Paket

Sie können das Minoo -Thema von PYPI installieren:

 $ pip Installieren Sie sphinx_minoo_theme

Um das Thema in Ihrem Sphinx -Projekt zu verwenden, bearbeiten Sie Ihre Sphinx -Konfigurationsdatei conf.py wie folgt:

 # Oben.
Importieren Sie sphinx_minoo_theme

# ...

Erweiterungen = ["sphinxcontrib.jQuery"]
html_theme = "sphinx_minoo_theme"
html_theme_path = [sphinx_minoo_theme.get_html_theme_path ()]

Über Git oder Download

Alternativ können Sie das Thema aus dem Repository herunterladen und sphinx_minoo_theme/sphinx_minoo_theme in Ihre Dokumentation unter _templates Ordner kopieren. Fügen Sie dann die folgenden Zeilen Ihrer conf.py -Datei hinzu:

 Erweiterungen = ["sphinxcontrib.jQuery"]
html_theme = "sphinx_minoo_theme"
html_theme_path = ["_templates"]

Anpassung

Um das MINOO -Thema anzupassen, befolgen Sie die folgenden Schritte:

1. Legen Sie Ihre Avatar -Bilddatei mit dem Namen avatar.jpg in den static Ordner ein.
2. Bearbeiten Sie das Thema der Themenkonfiguration Datei theme.conf :

• Richtung ändern:

   Richtung = ltr
  

  Setzen Sie sie für "rechts nach links" Sprachen auf rtl ein

• Fügen Sie Ihre Google Analytics -ID hinzu:

   analytics_id = ua-xxxxx-x
  

• Fügen Sie Ihre Website -Adresse und soziale Links hinzu:

   Website =
  Facebook =
  GooglePlus =
  linkedIn =
  Twitter =
  github = https://github.com/saeiddrv/SphinxMinoftheme
  gitlab =
  Bitbucket =
  

  Lassen Sie leer, was Sie nicht wollen.

3. Bearbeiten Sie die Datei glossary.html , um die Themenwörter zu ändern.

Lizenz

Minoo -Thema ist unter der MIT -Lizenz lizenziert. Weitere Informationen finden Sie in der Lizenzdatei.

Dankbarkeit

Ich möchte mich bei sphinx_rtd_theme dafür danken, dass sie mir geholfen haben, dieses Thema aufzubauen.