sphinxcontrib-taglist

وsphinxcontrib-taglist هو أبو الهول "taglist" التمديد.
TagList
Taglist هو امتداد لنظام التوثيق أبو الهول.
تركيب
التركيب من خلال نقطة:
PIP تثبيت sphinxcontrib-taglist
أو من خلال جيثب:
بوابة استنساخ https://github.com/spinus/sphinxcontrib-taglist
مؤتمر نزع السلاح sphinxcontrib-taglist
بيثون setup.py تثبيت
وبعد ذلك، لديك لإضافة ملحق إلى 'conf.py "في مشروع أبو الهول الخاص بك.
ملحقات = [
على & nbsp؛ ...،
على & nbsp؛ "sphinxcontrib.taglist،
على & nbsp؛ ...]
ترتيب
عندما علامات باستخدام مع هذا التمديد قد ترغب إعطاء كل علامة لون آخر. يمكنك أن تفعل ذلك في "conf.py" عن طريق إضافة:
taglist_tags = {
على & nbsp؛ "tag1 ': {' لون الخلفية ':' الأخضر '}
}
توجيهات
العلامة:
على & nbsp؛ العلامة التوجيه إضافة "قطعة" من المعلومات، ويمكنك وضع علامة على ذلك.
على & nbsp؛ يمكنك استخدامه مثل:
على & nbsp؛ .. العلامة :: بعض المعلومات الموسومة
على & nbsp؛: العلامة: tag1 TAG2 tag3
على & nbsp؛ أو:
على & nbsp؛ .. العلامة :: [tag1 TAG2 tag3] بعض المعلومات الموسومة
على & nbsp؛ تحذير: يستخدم الطريقة الثانية فقط إذا الأسلوب الأول هو لا.
على & nbsp؛ تحذير: لست متأكدا من هذا النحو، فإنه قد تتغير. إذا كان لديك اقتراحات العاني واسمحوا لي أن أعرف.
taglist:
على & nbsp؛ taglist هو التوجيه الذي قبض العلامات والقيام قائمة.
على & nbsp؛ أولا فإنه يطبع "الكلمات: ... 'مع المعلومات التي العلامات فإنه يعرض، ومن أنه يظهر القائمة.
على & nbsp؛ يمكنك استخدامه مثل:
على & nbsp؛ .. taglist ::
على & nbsp؛: العلامات: tag1 tag3
كيف يعمل؟
مشتق من مصدر برنامج-متطلبات sphinxcontrib بحيث أنه يعمل بطريقة مماثلة.
خلال وثيقة توجيهات العلامة القراءة تخلق tag_node`s. `taglist خلق العقد taglist.
خلال حل العقد taglist يتم تغييرها إلى قطعة من نص الكلمات: مع البنود الوسوم التي سيتم عرضها على تلك القائمة. التالي فإنه يطبع كل العناصر الموسومة.
CSS
taglist.css:
على & nbsp؛ ويحتوي على الفئة الأساسية للوسم - taglist_tag
على & nbsp؛ تحذير: إنه ربما سيتم تغيير وضعه في taglist_tags.css. (وأنه سيكون شكلي من conf.py)
بالإضافة إلى ذلك، فإنه يخلق taglist_tags.css الملف أثناء تجهيز (مع المغلق لكل العلامة قمت بتعريفه في conf.py، taglist_tags خرائط جميع مفاتيح دلالية لمفاتيح المغلق). والكتابة لبناء الدليل إلى الملفات الثابتة

المتطلبات:

بيثون
أبو الهول