Выгрузка печатных форм (print-doc)#

GetDocs позволяет генерировать DOCX и PDF файлы из исходных кодов документации.

Внимание

Загрузка файлов доступна для комплектов, предварительно собранных с помощью workflow build-doc.

Чтобы запустить загрузку, выполните следующие действия:

  1. Запустите workflow print-doc, указав необходимые параметры:

    Параметр

    Описание

    Пример

    code

    Код продукта

    PIF

    version

    Версия продукта

    * 1.2.3
    * 3.2.1

    documents

    Список документов, которые надо создать, через запятую. Если список пуст, то создаются все документы из комплекта

    administration-guide*,user-guide*

    include_components

    Если в параметре code передан код продукта, и текущий параметр равен yes, будут также созданы выгружены документы включенных в продукт компонентов

    * yes
    * no

    format

    Формат выгружаемых файлов

    * pdf
    * docx

    package

    Формат пакета с документами

    * std
    * fstec

  2. Когда workflow выполнится (т.е. когда корневой узел графа станет зеленым), нажмите на нижний узел графа с названием <date>-SBT-DOC_<code>_<version>.zip и загрузите архив с выгруженными документами.

Также запустить print-doc можно с сайта со страницы версии документации, нажав кнопку Скачать PDF:

скачать

Workflow будет запущен с кодом и версией открытого на сайте комплекта документации.