Tema Sphinx ini dirancang untuk memberikan pengalaman pembaca yang luar biasa bagi pengguna dokumentasi di desktop dan perangkat seluler. Tema ini digunakan terutama pada Read the Docs tetapi dapat bekerja dengan proyek Sphinx apa pun. Anda dapat menemukan demo tema yang berfungsi di dokumentasi tema
Tema ini didistribusikan di PyPI dan dapat diinstal dengan pip
:
$ pip instal tema sphinx-rtd
Untuk menggunakan tema dalam proyek Sphinx Anda, Anda perlu mengedit pengaturan html_theme
file conf.py
Anda:
html_tema = "sphinx_rtd_tema"
Lihat juga:
Browser yang didukung
Kombinasi browser/sistem operasi yang didukung dan diuji secara resmi
Ketergantungan yang didukung
Versi Python, Sphinx, dan dependensi lainnya yang didukung.
Contoh dokumentasi
Contoh lengkap keluaran tema ini, dengan string yang dilokalkan diaktifkan.
Tema ini sangat dapat disesuaikan baik di tingkat halaman maupun di tingkat global. Untuk melihat semua opsi konfigurasi yang memungkinkan, baca dokumentasi tentang konfigurasi tema.
Jika Anda ingin membantu memodifikasi atau menerjemahkan tema, Anda akan menemukan informasi lebih lanjut tentang berkontribusi dalam panduan kontribusi kami.