sphinxcontrib-taglist

sphinxcontrib-taglist ay Sphinx "taglist" extension ng.
TagList
Taglist ay isang extension sa Sphinx dokumentasyon ng sistema.
Pag-install
Instalation sa pamamagitan ng buto ng bungang-kahoy:
buto ng bungang-kahoy-install sphinxcontrib-taglist
o sa pamamagitan ng github:
Git clone https://github.com/spinus/sphinxcontrib-taglist
cd sphinxcontrib-taglist
python setup.py-install
Susunod, kailangan mong magdagdag ng mga extension sa 'conf.py' sa iyong proyekto sphinx.
extension = [
& Nbsp; ...,
& Nbsp; 'sphinxcontrib.taglist',
& Nbsp; ...]
Configuration
Kapag gumagamit ng mga tag sa extension na ito maaaring gusto bigyan ang bawat tag ng iba pang mga kulay. Magagawa mo iyon sa 'conf.py' sa pamamagitan ng pagdaragdag:
taglist_tags = {
& Nbsp; 'tag1': {'background-color': 'berde'}
}
Direktiba
tag:
& Nbsp; tag direktiba magdagdag ng 'piraso' ng impormasyon, at maaari mo itong i-tag.
& Nbsp; Maaari mo itong gamitin tulad ng:
& Nbsp; .. tag :: Ang ilang mga naka-tag na impormasyon
& Nbsp;: tag: tag1 tag2 tag3
& Nbsp; o:
& Nbsp; .. tag :: [tag1 tag2 tag3] Ang ilang mga naka-tag na impormasyon

& Nbsp; Babala: Pangalawa pamamaraan ay ginagamit lamang kung unang paraan ay hindi.
& nbsp; Babala: am Hindi ko ba ang syntax na ito, maaari itong baguhin. Kung mayroon kang mga mungkahi anny mangyaring ipaalam sa akin.
taglist:
& Nbsp; taglist ay isang kautusang na mahuli ang mga tag at gawin ang isang listahan.
& Nbsp; Una ito ng mga Kopya 'Tags: ...' ng impormasyon kung aling mga tag ito ay nagpapakita, at kaysa ito ay nagpapakita ng mga listahan.
& Nbsp; Maaari mo itong gamitin tulad ng:
& Nbsp; .. taglist ::
& Nbsp;: mga tag: tag1 tag3
Paano ito gumagana?
Ang codebase ay nagmula sa sphinxcontrib-kinakailangan kaya ito gumagana sa parehong paraan.
Sa panahon ng dokumento kautusan pagbabasa tag lumikha tag_node`s. `Taglist lumikha taglist node.
Sa panahon ng paglutas taglist node ay pinalitan sa isang piraso ng teksto Tags: gamit ang mga tag ng mga item na ipapakita sa listahang iyon. Susunod na ito ng mga Kopya lahat ng mga tag item.
CSS
taglist.css:
& Nbsp; Naglalaman ito base klase para sa tag - taglist_tag

& Nbsp; Babala: marahil ito ng ay nagbago at ilagay sa taglist_tags.css. (At ito ay maaaring i-configure mula sa conf.py)
Bukod pa rito, ito ay lumilikha ng mga file taglist_tags.css sa panahon ng pagproseso ng (na may css para sa bawat tag mo nilinaw sa conf.py; taglist_tags mapa ang lahat ng mga key tag sa css key). At isulat ito upang bumuo ng direktoryo sa static na mga file

Mga Kinakailangan :

• Python
• Sphinx