sphinxcontrib-taglist

sphinxcontrib-taglist adalah Sphinx "taglist" ekstensi.
TagList
Taglist adalah perluasan sistem dokumentasi Sphinx.
Instalasi
Instalasi melalui pip:
pip menginstal sphinxcontrib-taglist
atau melalui github:
git clone https://github.com/spinus/sphinxcontrib-taglist
cd sphinxcontrib-taglist
python setup.py install
Selanjutnya, Anda harus menambahkan ekstensi untuk 'conf.py' dalam proyek sphinx Anda.
ekstensi = [
& Nbsp; ...,
& Nbsp; 'sphinxcontrib.taglist',
& Nbsp; ...]
Konfigurasi
Bila menggunakan tag dengan ekstensi ini Anda mungkin ingin memberikan setiap tag warna lain. Anda dapat melakukannya di 'conf.py' dengan menambahkan:
taglist_tags = {
& Nbsp; 'tag1': {'background-color': 'hijau'}
}
Arahan
tag:
& Nbsp; tag direktif menambahkan 'sepotong' informasi, dan Anda dapat tag.
& Nbsp; Anda dapat menggunakannya seperti:
& Nbsp; .. tag :: Beberapa informasi tagged
& Nbsp;: tag: tag1 tag2 tag3
& Nbsp; atau:
& Nbsp; .. :: tag [tag1 tag2 tag3] Beberapa informasi tagged

& Nbsp; Peringatan: Metode kedua hanya digunakan jika metode pertama tidak.
& nbsp; Peringatan: Saya tidak yakin sintaks ini, mungkin berubah. Jika Anda memiliki saran anny tolong beritahu saya.
taglist:
& Nbsp; taglist adalah direktif yang menangkap tag dan melakukan daftar.
& Nbsp; Pertama mencetak 'Tags: ...' dengan informasi yang tag ini akan menampilkan, dan daripada itu menunjukkan daftar.
& Nbsp; Anda dapat menggunakannya seperti:
& Nbsp; .. taglist ::
& Nbsp;: tags: tag1 tag3
Bagaimana cara kerjanya?
Basis kode berasal dari sphinxcontrib-persyaratan sehingga bekerja dengan cara yang sama.
Selama dokumen arahan tag membaca membuat tag_node`s. `Taglist membuat node taglist.
Selama menyelesaikan node taglist berubah menjadi sepotong teks Tags: dengan tag item yang akan ditampilkan dalam daftar itu. Selanjutnya mencetak semua item ditandai.
CSS
taglist.css:
& Nbsp; Ini berisi kelas dasar untuk tag - taglist_tag

& Nbsp; Peringatan: Mungkin akan berubah dan dimasukkan ke dalam taglist_tags.css. (Dan itu akan dikonfigurasi dari conf.py)
Selain itu, ia menciptakan file taglist_tags.css selama pemrosesan (dengan css untuk setiap tag Anda didefinisikan dalam conf.py; taglist_tags peta semua kunci tag dengan kunci css). Dan menulis ke direktori tempat file statis

Persyaratan :

• Python
• Sphinx