I nazariy qism

Hujjatlarni shakllantirish
Hujjatlarni yaratish uchun avval uni qurishingiz kerak. Hujjatni yaratish uchun bir nechta paketlar kerak bo'ladi, ularni kod omborining ildiziga quyidagi buyruq bilan o'rnatishingiz mumkin:
pip install -e ".[docs]"
Keyin hujjatlarni tuzadigan maxsus vositamizni o'rnatishingiz kerak:
pip install git+https://github.com/huggingface/doc-builder
Hujjatlarni oldindan ko'rish
Hujjatlarni oldindan ko'rish uchun birinchi navbatda watchdog modulini o'rnating:
pip install watchdog
Keyin quyidagi buyruqni bajaring:
doc-builder preview {package_name} {path_to_docs}
Masalan:
doc-builder preview transformers docs/source/en/
Hujjatlarni http://localhost:3000 manzilida ko'rish mumkin. Shuningdek, siz PR ochganingizdan so'ng hujjatlarni oldindan ko'rishingiz mumkin. Hujjatlaringiz o'z o'zgartirishlaringiz saqlanadigan havolaga sharh qo'shadigan botni ko'rasiz.
Navigatsiya paneliga yangi element qo'shish
Qabul qilingan fayllar Markdown (.md yoki .mdx).
Kengaytmali fayl yarating va uni manba katalogiga qo'ying. Keyin _toctree.yml fayliga kengaytmasiz fayl nomini qo'yish orqali uni toc-tree bilan bog'lashingiz mumkin.
Bo'lim sarlavhalari va harakatlanuvchi bo'limlar nomini o'zgartirish
Bu bo'lim sarlavhasi nomini o'zgartirish va/yoki bo'limlarni bir hujjatdan boshqasiga ko'chirishda eski havolalarning ishlashini ta'minlashga yordam beradi. Buning sababi shundaki, eski havolalar Muammolar, Forumlar va Ijtimoiy tarmoqlarda qo'llanilishi mumkin va agar o'sha oylardan keyin o'qigan foydalanuvchilar dastlab mo'ljallangan ma'lumotlarga osongina o'tishlari mumkin bo'lsa, bu foydalanuvchi tajribasini yanada yaxshilaydi.
Shuning uchun, biz hujjatning oxirida asl bo'lim bo'lgan joyda ko'chirilgan bo'limlarning kichik xaritasini saqlaymiz. Asosiysi, asl langarni saqlab qolish.
Shunday qilib, agar siz bo'lim nomini "A" bo'limidan "B" bo'limiga o'zgartirgan bo'lsangiz, faylning oxiriga qo'shishingiz mumkin:
Sections that were moved:
[ Section A ]
va, albatta, agar siz uni boshqa faylga ko'chirsangiz, unda:
Sections that were moved:


[ Section A ]
Versiyalangan hujjatlar ishlashda davom etishi uchun yangi faylga ulanish uchun nisbiy uslubdan foydalaning.
Ko'chirilgan bo'limlar to'plamiga misol uchun Trener hujjatining oxiriga qarang.