Go to file
Rafael c82a604a03 Описание общей архитектуры приложения 2024-08-01 16:00:28 +05:00
.vscode инициализация репозитория 2023-04-11 14:28:15 +05:00
custom_theme инициализация репозитория 2023-04-11 14:28:15 +05:00
docs Описание общей архитектуры приложения 2024-08-01 16:00:28 +05:00
mkdocs build.os 2024-03-15 11:35:44 +05:00
.gitignore инициализация репозитория 2023-04-11 14:28:15 +05:00
.readthedocs.yaml build.os 2024-03-15 11:35:44 +05:00
admin-manuals.yml инициализация репозитория 2023-04-11 14:28:15 +05:00
dev.yml чистка инструкций 2023-06-02 18:05:38 +05:00
mkdocs.yml чистка инструкций 2023-06-02 18:05:38 +05:00
readme.md инициализация репозитория 2023-04-11 14:28:15 +05:00
user-manuals.yml инициализация репозитория 2023-04-11 14:28:15 +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

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

а) ![Рис 1](examplel.png){: .zoom}
б) <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