SphinxMinooTheme

Minoo

Minoo Theme adalah tema Sphinx yang mendukung bahasa kanan-ke-kiri seperti Persia. Ini tersedia di PYPI dan memungkinkan pengembang untuk membuat situs web dokumentasi dengan desain elegan dan fungsional yang bekerja dengan baik dengan bahasa RTL.

Isi

• Fitur
• Instalasi
  • Melalui paket
  • Melalui git atau unduh
• Kustomisasi
• Lisensi
• Rasa syukur

Fitur

• Warna material
• Dukungan Bahasa RTL
• Desain responsif
• Integrasi Google Analytics
• Tautan Sosial dan Avatar
• Bebas digunakan

Instalasi

Melalui paket

Anda dapat menginstal tema Minoo dari PYPI:

 $ Pip Instal SPHINX_MINOO_THEME

Untuk menggunakan tema dalam proyek sphinx Anda, conf.py file konfigurasi sphinx Anda sebagai berikut:

 # Di atas.
Impor sphinx_minoo_theme

# ...

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

Melalui git atau unduh

Atau, Anda dapat mengunduh tema dari repositori dan menyalin sphinx_minoo_theme/sphinx_minoo_theme ke dalam dokumentasi Anda di folder _templates . Kemudian, tambahkan baris berikut ke file conf.py Anda:

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

Kustomisasi

Untuk menyesuaikan tema Minoo, ikuti langkah -langkah ini:

1. Masukkan file gambar Avatar Anda ke dalam folder static dengan nama avatar.jpg .
2. Edit tema file tema theme.conf :

• Ubah arah:

   arah = ltr
  

  Untuk bahasa "kanan-ke-kiri", atur ke rtl

• Tambahkan ID Google Analytics Anda:

   analytics_id = ua-xxxxx-x
  

• Tambahkan alamat situs web dan tautan sosial Anda:

   situs web =
  Facebook =
  googleplus =
  LinkedIn =
  Twitter =
  github = https://github.com/saeiddrv/sphinxminootheme
  gitlab =
  bitbucket =
  

  Tinggalkan kosong mana yang tidak Anda inginkan.

3. Edit file glossary.html untuk mengubah kata -kata tema.

Lisensi

Tema Minoo dilisensikan di bawah lisensi MIT. Untuk informasi lebih lanjut, lihat file lisensi.

Rasa syukur

Saya ingin mengucapkan terima kasih kepada sphinx_rtd_theme karena telah membantu saya membangun tema ini.