sphinxcontrib-taglist เป็นสฟิงซ์ "taglist" ขยาย
TagList
Taglist เป็นส่วนขยายไปยังระบบเอกสารสฟิงซ์
การติดตั้ง
instalation ผ่านจุด:
PIP ติดตั้ง sphinxcontrib-taglist
หรือผ่าน GitHub:
คอมไพล์โคลน https://github.com/spinus/sphinxcontrib-taglist
cd-sphinxcontrib taglist
หลาม setup.py ติดตั้ง
ถัดไปคุณต้องเพิ่มขยาย 'conf.py ในโครงการสฟิงซ์ของคุณ
นามสกุล = [
& nbsp; ...
& nbsp; 'sphinxcontrib.taglist',
& nbsp; ... ]
การตั้งค่า
เมื่อใช้แท็กที่มีนามสกุลนี้คุณอาจต้องการให้แต่ละแท็กสีอื่น ๆ คุณสามารถทำใน 'conf.py' โดยการเพิ่ม:
taglist_tags = {
& nbsp; 'tag1': {'background-color': 'สีเขียว'}
}
Directives
แท็ก:
& nbsp; สั่งเพิ่มแท็ก 'ชิ้นส่วนของข้อมูลและคุณสามารถแท็ก
& nbsp; คุณสามารถใช้มันเช่น:
& nbsp; .. tag :: บางข้อมูลที่ติดแท็ก
& nbsp;: แท็ก: tag1 tag2 tag3
& nbsp; หรือ:
& nbsp; .. แท็ก :: [tag1 tag2 tag3] บางข้อมูลที่ติดแท็ก
& nbsp; คำเตือน: วิธีที่สองคือใช้เฉพาะในกรณีที่วิธีแรกคือการไม่ได้
& nbsp; คำเตือน: ผมไม่แน่ใจว่ารูปแบบนี้ก็อาจมีการเปลี่ยนแปลง หากคุณมีข้อเสนอแนะ Anny โปรดแจ้งให้เราทราบ
taglist:
& nbsp; taglist เป็นคำสั่งที่แท็กจับและทำรายการ
& nbsp; ประการแรกมันพิมพ์ 'แท็ก: ... ' มีข้อมูลที่แท็กจะแสดงและเกินกว่าที่จะแสดงรายการ
& nbsp; คุณสามารถใช้มันเช่น:
& nbsp; .. taglist ::
& nbsp;: แท็ก: tag1 tag3
มันทำงานอย่างไร?
codebase มาจาก sphinxcontrib ความต้องการเพื่อให้การทำงานในลักษณะที่คล้ายกัน
ในระหว่างการสั่งแท็กอ่านเอกสารสร้าง tag_node`s `taglist สร้างโหนด taglist
ในระหว่างการแก้ไขโหนด taglist ถูกเปลี่ยนเป็นชิ้นส่วนของข้อความแท็ก: กับรายการแท็กซึ่งจะปรากฏอยู่ในรายชื่อที่ ถัดไปจะพิมพ์รายการติดแท็กทั้งหมด
CSS
taglist.css:
& nbsp; มันมีชั้นฐานสำหรับแท็ก - taglist_tag
& nbsp; คำเตือน: มันอาจจะมีการเปลี่ยนแปลงและใส่ใน taglist_tags.css (และก็จะมีการกำหนดค่าจาก conf.py)
นอกจากนี้จะสร้างไฟล์ taglist_tags.css ระหว่างการประมวลผล (กับ CSS สำหรับแต่ละแท็กที่คุณกำหนดไว้ใน conf.py; taglist_tags แผนที่คีย์แท็กทั้งหมดคีย์ CSS). และเขียนเพื่อสร้างไดเรกทอรีกับไฟล์แบบคงที่
ต้องการ
- หลาม
- สฟิงซ์
ความคิดเห็นที่ไม่พบ