Как импортировать phpDoc в Confluence?

Question

Я ищу правильный способ использования phpDoc-комментариев из проекта для генерации документации разработчика внутри моего Confluence 4.1.4.

Answer 1

Один из подходов, которые я рассмотрел, заключается в том, чтобы развернуть вывод HTML (похожий на phpDoc) в качестве второго веб-приложения на экземпляре Tomcat в Confluence, а затем перевести этот документ в iFrame на страницу Confluence.Он не интегрируется с поиском / индексацией или маркировкой Confluence, но он должен хорошо сочетаться с установленной нами схемой аутентификации Crowd.Я полагаю, что затем смогу использовать федеративный инструмент поиска для поиска по двум веб-приложениям.

Answer 2

Я ищу то же решение.Самое близкое, что я пришел, - это использование html2wiki, который имеет диалект для Confluence.Я создал PHP-скрипт, который рекурсивно просматривает мой каталог api и обрабатывает каждую html-страницу с помощью этой html2wiki-программы.К сожалению, он не идеально форматирует разметку и оставляет нежелательные html-артефакты.

Мой следующий подход - попытаться настроить диалект самостоятельно, чтобы попытаться исправить плохое форматирование.

http://search.cpan.org/~diberri/HTML-WikiConverter-0.51/bin/html2wiki

Answer 3

Вы можете использовать плагин Docs: https://marketplace.atlassian.com/plugins/net.meixxi.confluence.docs.docs-plugin. Этот плагин позволяет загружать и публиковать ваши PHPDocs и другой контент на основе HTML и JavaScript в Confluence.

Документы также предоставляют интерфейс REST для автоматизации процесса публикации. Таким образом, публикация PHPDocs может стать частью процесса непрерывной интеграции. Техническую документацию, а также пример кода вы можете найти здесь: https://bitbucket.org/meixxi/docs-plugin/wiki/Home