Сборка документации (build-doc)#

GetDocs позволяет собрать документацию по ссылке репозитория для дальнейшей публикации на статическом сайте с помощью workflow build-doc. Сборка происходит изолированно от общего сайта, поэтому документация появится там только тогда, когда дополнительно будет выполнен workflow build-site.

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

    Параметр

    Описание

    Пример

    repo_url

    Ссылка на репозиторий документации

    * docdev/a-paradigm
    * https://my-domain.ru/bitbucket-ci/projects/DOCDEV/repos/a-paradigm/browse
    * https://my-domain.ru/bitbucket-ci/scm/docdev/a-paradigm.git
    * ssh://git@my-domain:7998/docdev/a-paradigm.git

    repo_branch

    Ветка репозитория документации (если не указана, то используется ветка по умолчанию)

    * master
    * release/1.2.3

    repo_commit

    Коммит репозитория документации (имеет приоритет над веткой)

    * 1a111111a1a
    * a1a11aaa1aaaa1111a1aa1a1a1111a1a1aaa1111

    doc_dir

    Путь до папки с документацией в репозитории. Указывается относительно корня репозитория. Если пусто, то собирается папка, в которой расположен doc-config.ini. Если в репозитории несколько doc-config.ini (несколько комплектов документов), то нужно указывать путь до нужного doc-config.ini

    * documentation
    * path/to/docs

    config_file

    Имя конфигурационного файла. Задается, если название отличается от стандартного doc-config.ini

    doc-config-pif.ini

    code

    Код продукта/компонента (имеет приоритет над кодом в doc-config.ini)

    * PIF
    * GDOC

    version

    Версия продукта/компонента (имеет приоритет над версией в doc-config.ini)

    * 1.2.3
    * 3.2.1

  2. Когда workflow выполнится (т.е. когда корневой узел графа станет зеленым), нажмите на узел графа с названием report-draft-std-ext.html.
    Справа появится предпросмотр отчета.

  3. Чтобы открыть отчет на всю страницу, нажмите внизу кнопку REPORT-DRAFT-STD-EXT.HTML.

Отчет сборки документации

По умолчанию на данном этапе также происходит валидация документации. Подробнее работа с данным отчетом описана в разделе Работа с отчетом сборки документации.

Чтобы посмотреть все созданные отчеты сборки (все комбинации <stage>-<package>-<audience>), выполните шаги из раздела Просмотр всех отчетов сборки.