Go to file
mirzakaev_tf bef5849d5e 24217 контексный поиск 2024-12-26 11:10:37 +05:00
.vscode реструктаризация 2023-10-20 10:18:10 +05:00
custom_theme разделение инструкции на юзерскую 2023-04-05 11:58:38 +05:00
docs 24217 контексный поиск 2024-12-26 11:10:37 +05:00
mkdocs mkdocs-glightbox==0.3.4 2023-11-28 14:10:41 +05:00
.gitignore сз на ком на кон и обзор опубликов 2024-02-06 11:30:56 +05:00
.readthedocs.yaml редакция yaml 2023-10-06 17:45:04 +05:00
admin-manuals.yml разделение инструкции на юзерскую 2023-04-05 11:58:38 +05:00
dev.yml 21164 исх на конструкторе 2024-07-02 16:25:29 +05:00
mkdocs.yml отображение вкладки 2024-05-02 11:39:19 +05:00
readme.md 15559 штамп по сотруднику+удал зум 2023-11-16 13:40:15 +05:00
user-manuals.yml read url 2023-11-03 09:51:30 +05:00

readme.md

Для разработки и проверки документации можно использовать команды

  • mkdocs serve (с созданием pdf файлов)
  • mkdocs serve -f dev.yml (без создания pdf файлов)
  • mkdocs build -f admin-manuals.yml (с созданием pdf файла с инструкциями для администратора)

Перед запуском надо установить mkdocs и его расширения. Сделать это можно при помощи команды, запущенной в папке mkdocs

pip install -r requirements.txt

Чтобы включить увеличение изображения, необходимо добавить . Если не работает (а это происходит при работе плагина img2fig), то использовать html-вариант. Автоматический конвертер первого варианта во второй (zoom.py) есть в bitedo-doc и документации ERP.

а) ![Рис 1](examplel.png)
б) <img alt="Рис 1" src="examplel.png" class="zoom"/>

В случае ошибки no library called "cairo" was found необходимо скачать библиотеки:

https://github.com/tschoonj/GTK-for-Windows-Runtime-Environment-Installer

https://github.com/tschoonj/GTK-for-Windows-Runtime-Environment-Installer/releases

Если при запуске команды mkdocs serve -f dev.yml появляется ошибка что данная команда не определена, то в переменнах средах укажите путь: C:\Users\User\AppData\Roaming\Python\Python310\Scripts