Исходный код

Репозиторий исходного кода для этой документации.

https://spacecruft.org/deepcrayon/transpolibre

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

Создание документации

Чтобы построить эту документацию локально, выполните следующее.

Установите зависимости

Установите зависимости, как в Debian:

sudo apt update
sudo apt install python-is-python3 python3-pip python3-venv

Скачать документацию Источник

git clone https://spacecruft.org/deepcrayon/transpolibre
cd transpolibre/

Настройка Python

python -m venv venv
source venv/bin/activate
pip install -U pip setuptools wheel

Документация Создание справки

Для получения помощи по сборке документации выполните:

make help

Это отобразит эту справку:

Please use 'make <target>' where <target> is one of
  clean                Remove all build files and directories (including translations)
  all                  Clean and make all targets
  gettext_build        Build localisation strings for translation
  update_locale        Update localisation
  update_locale_<lang> Update localisation for <lang>
  html                 Build the HTML documentation for all languages
  html_<lang>          Build HTML documentation for <lang>
  latex                Build the documentation using LaTeX for all languages
  latex_<lang>         Build the documentation using LaTeX for <lang>
  pdf                  Build the PDF documentation using LaTeX for all languages
  pdf_<lang>           Build the PDF documentation using LaTeX for <lang>
  ebook                Reduce size of PDF for eBook
  prepress             Reduce size of PDF for prepess
  index                Copy static docs/index.html to docs/_build/html/index.html
  translations         Translate from English

Чисто

Таким образом, очистите артефакты сборки.

make clean

Создание документации в формате HTML

Чтобы создать документацию в формате HTML, выполните:

make index
make html

Полученный HTML будет находиться в docs/_build/html/, а файл верхнего уровня index.html будет находиться здесь: docs/index.html.

Создание PDF-файла в LaTex

Чтобы создать PDF-документ из сборки LaTeX, сначала установите зависимости (это гораздо больше, чем нужно):

sudo apt install texlive-full

Затем постройте документы LaTeX и PDF:

make latex

Создание PDF

Чтобы создать PDF-документ из LaTeX:

make pdf

Полученный PDF будет здесь: docs/_build/latex/en/transpolibre.pdf.

Электронная книга

Чтобы значительно уменьшить размер PDF до 150 dpi для электронной книги, выполните:

make ebook

Полученный PDF будет здесь: docs/_build/latex/en/transpolibre-ebook-en.pdf.

Предпечатная подготовка

Чтобы уменьшить размер PDF до 300 dpi для печати, выполните:

make prepress

Полученный PDF будет здесь: docs/_build/latex/en/transpolibre-prepress-en.pdf.

Собрать всю документацию

Составить всю документацию, включая HTML и PDF.

make all

Переводы

См. «README.md» для заметок о том, как обновить переводы пакетов.