Тусламж

Гарын авлага бичихэд шаардагдах ерөнхий заавар, нийтлэг шаардлага, дүрэм, журам болон Markdown syntax-ын зааврын талаар товч мэдээлэл байна.

Ерөнхий заавар

Хэрэгтэй байж болох ихэнх боломжуудыг энэхүү загвар дээр тусгасан байгаа бөгөөд Readthedocs, SPHINX холбоос дээр дарж ерөнхий кодын зааврыг дэлгэрүүлж харж болно.

Manual холбоосоор орж ерөнхий заавартай танилцана. Дээрх зааврын Template хуулбарлах хэсгийн 7-д заасан өөрчлөлт хийх гэдэг нь дараах заавруудыг хэлж байгаа болно.

  • Ерөнхий тохиргоо conf.py гэсэн файлд байна. Тухайн файлд байгаа Өөрчлөх => гэсэн хэсгүүдийг өөрчилнө.

  • Ерөнхий эхлэл хуудас нь index.rst гэсэн файлд байна. Тухайн файлд зүүн талын цэсэд гарах файлуудыг зааж өгөх бөгөөд зааж өгөх файл нь .rst гэсэн өргөтгөлтэй байна. Мөн давхар тухайн хуудасны заавар байгааг сайтар анхаараарай.

  • Template-ээр үүсгэсэн байгаа menu1-menu6 .rst файлуудыг rename хийж ашиглаж болно. rename хийсэн бол index.rst гэсэн файлд давхар өөрчлөлт орохыг анхаараарай.

  • Цэс 2.2-т байгаа заавартай сайтар танилцаж, цэс хоорондын холбоосыг ашиглана.

  • Ашиглах зурагнуудыг img гэсэн фолдерт хийнэ.

  • _static гэсэн фолдерт байгаа custom.js болон my_theme.css файлд javascript болон өөрийн css-ийг бичиж өгөх боломжтой.

  • contact.rst гэсэн файлд байгаа холбоо барих мэдээллийг шаардлагатай тохиолдолд өөрчилж болно.

  • faq.rst гэсэн файлд тухайн гарын авлага бичиж байгаа систем эсвэл үйлчилгээний түгээмэл асуулт, хариултыг хувилбар 1 болон хувилбар 2-оос сонгож бичнэ.

  • Production руу GIT-ээр deploy хийхээсээ өмнө index.rst файлд байгаа Тусламж <help.rst> хэсгийг авч хаяна.

Warning

Дээр дурдсанаас бусад файл болон тохиргоог өөрчлөх шаардлагагүй.

Нийтлэг шаардлага, дүрэм, журам

Дараах шаардлага, дүрэм, журмыг дагаж мөрдөнө. Үүнд:

  1. Үндсэн загварыг эвдэхгүй байх

  2. Агуулга нь ойлгомжтой, энгийн, тодорхой байх

  3. Шилжсэн утгатай үг, далд утга хэрэглээгүй байх

  4. Хар ярианы үг, этгээд, бүдүүлэг үг хэллэг, нутгийн аялгууны үг хэрэглэхгүй байх

  5. Хүний нэр, албан тушаал, хаяг, он, сар зэргийг оруулах бол үнэн зөв бичих

  6. Өөрийн гэсэн логотой байх (Логоны урт нь 200px-ээс хэтрэхгүй байна)

  7. Эхлэл хуудсыг товч тайлбар, агуулга болон цэснээс бүрдүүлэх

  8. Цэсний нэршил болон .rst файлын нэрийг товч бөгөөд тодорхой өгөх

  9. Цэс хооронд хоосон зай үлдээхгүй байх (Заавал ямар нэгэн тодорхойлолт эсвэл өгүүлбэр байна. Жишээ нь: Дээр байгаа Тусламж болон Ерөнхий заавар гэсэн цэс хооронд бичсэн шиг бичвэр заавал байна гэсэн үг юм)

  10. Ашиглах зураг нь өөрөө ямар нэгэн тайлбартай байж болохгүй бөгөөд зургийн нэрийг товч бөгөөд тодорхой өгч img гэсэн фолдерт хийх. Мөн зургийн уртын хэмжээг нэг стандартаар барих.

  11. Тохирох Markdown syntax-г өргөн ашиглах

  12. Удирдах ажилтанд хянуулж байж production deploy хийх

Markdown syntax

https://www.markdownguide.org/ , https://sphinxdocs.ansys.com/dev/examples/sphinx-design.html#cards-clickable , https://sphinx-design.readthedocs.io/en/latest/badges_buttons.html#inline-icons , https://sphinx-design.readthedocs.io/en/furo-theme/css_classes.html , https://fonts.google.com/icons?selected=Material+Icons+Outlined:place:&icon.set=Material+Icons болон https://sublime-and-sphinx-guide.readthedocs.io/en/latest/topics.html холбоос дээр дарж гарын авлага бичихэд шаардлагатай Markdown syntax-ын зааврыг харж болно. Зарим хэсгийг дор товч оруулав.

Bold текст оруулах бол ==> Bold text

Italic текст оруулах бол ==> Italic text

Линк оруулах бол ==> линк

Цэс холбох бол ==> Хичээл сонголт (menu3.rest гэсэн файл байх ёстой)

Дэд цэс холбох бол ==> Хувийн төлөвлөгөө (menu2.rest гэсэн файлд menu2.2 гэсэн холбоос байх ёстой)

Тусгайлан ялгах бол ==> text

Тусгайлан ялгах бол ==> text

Octicon icon оруулах бол ==>

Octicon css-тэй icon оруулах бол ==>

Octicon css-тэй icon оруулах бол ==>

Material Design icon оруулах бол ==>

Material Design css-тэй icon оруулах бол ==>

List ашиглах бол ==>

  1. Step 1.

  2. Step 2.

  3. Step 3.

  • Item 1.

    • Item a.

    • Item b.

  • Item 2.

  1. Step 1.

    1. Step a.

    2. Step b.

  2. Step 2.

Код бичих бол ==>

(.venv) $ pip install lumache

Тэмдэглэл бичих бол ==>

Note

Энд тэмдэглэл бичнэ.

Зөвлөгөө бичих бол ==>

Tip

Энд зөвлөгөө бичнэ.

Анхааруулга бичих бол ==>

Warning

Энд анхааруулга бичнэ.

Хүснэгт оруулах бол ==>

Хүснэгтийн нэр

Heading row 1, column 1

Heading row 1, column 2

Heading row 1, column 3

Row 1, column 1

Row 1, column 3

Row 2, column 1

Row 2, column 2

Row 2, column 3

Зураг оруулах бол ==>

Logo

Зургийн нэр

Тэмдэг ашиглах бол ==>

plain badge

primary, primary-line

secondary, secondary-line

success, success-line

info, info-line

warning, warning-line

danger, danger-line

light, light-line

dark, dark-line

Товч ашиглах бол ==>

https://example.com

Button text

https://example.com

https://example.com

https://example.com

Шошго ашиглах бол ==>

Card Title

Card content

Өөрийн css-тэй div үүсгэх бол ==>

Some CSS styled text

Задралт/хураалт хийх бол ==>

Dropdown content

Dropdown title

Dropdown content

Open dropdown

Dropdown content

Баганаар хуваалт хийх бол ==>

A

Title 2

B

Title 3

C

Нэг мөрөөр ижил баганатай хуваалт хийх бол ==>

Title 1

A

Title 2

B

Title 3

C

Олон мөрөөр ижил/олон баганатай хуваалт хийх бол ==>

gutter нь хоорондын зайг илэрхийлнэ.

A

Title 1

A

Title 2

B

A

B

C

Таб ашиглах бол ==>

Content 1

Content 2

Тайлбар толь бичих бол ==>

Sphinx

Sphinx is a tool that makes it easy to create intelligent and beautiful documentation. It was originally created for the Python documentation, and it has excellent facilities for the documentation of software projects in a range of languages.

Sublime Text

Sublime Text is a sophisticated text editor for code, markup and prose. You’ll love the slick user interface, extraordinary features and amazing performance.

Тайлбар толийг text-д холбох бол ==> Sphinx