Skip to content

GradusXaker/docs.ubports.com

 
 

Repository files navigation

docs.ubports.com banner

docs.ubports.com

Документация UBports в едином рабочем репозитории. Исходники сайта, сборка, переводы и документационный workflow.

Documentation UBports Python Sphinx Translations Site

> repo: docs.ubports.com
> pipeline: build docs / update translations / publish site
> role: source of truth for UBports documentation

обзор

Этот репозиторий нужен для сборки и сопровождения сайта документации UBports, включая локальную сборку, обновление переводов и документированный процесс внесения изменений.

Как вносить изменения

Правила и рекомендации по участию описаны здесь:

Перед отправкой изменений лучше придерживаться всех требований с этой страницы, иначе вклад могут не принять.

Сборка документации

Собрать документацию можно командой из корня репозитория:

./build.sh

Скрипт также создаст виртуальное окружение в ~/ubportsdocsenv, если его еще нет.

После завершения сборки открыть результат можно локально, например так:

firefox _build/html/index.html

Обновление переводов

Чтобы обновить .po-файлы переводов, выполните:

./update-translations.sh

Чтобы добавить новый язык, внесите его ISO-код в languagues.sh, а затем снова запустите:

./update-translations.sh

контакты

GitHub VK Email

About

Документация UBports

Topics

Resources

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • Python 54.1%
  • Shell 28.0%
  • Makefile 6.6%
  • CSS 5.8%
  • HTML 5.5%