How to import phpDoc in Confluence?

Question

I am looking for a suitable way to use phpDoc comments from a project to create developer documentation inside my Confluence 4.1.4.

Answer 1

One approach that I was considering is to deploy my HTML output (similar to phpDoc) as a second web application on an instance of Confluence Tomcat and then in an iFrame so that the doc goes to the Confluence page. It does not integrate with Confluence search / indexing or tagging, but it should work well with the Crowd authentication scheme we have set up. I believe that then I can use the integrated search tool to search two web applications.

Answer 2

I am looking for the same solution. Closest I came using html2wiki, which has a dialect for Confluence. I created a PHP script that recurses through my api directory and processes each html page using this html2wiki program. Unfortunately, it doesn't format the markup perfectly and leaves unwanted html artifacts.

My next approach is to try to tweak the dialect itself to try to resolve bad formatting.

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

Answer 3

You can use the Docs plugin: https://marketplace.atlassian.com/plugins/net.meixxi.confluence.docs.docs-plugin . This plugin allows you to download and publish your PHPDocs and other HTML and JavaScript based materials in Confluence.

Documents also provide a REST interface for automating the publishing process. In this way, publishing PHPDocs can be part of a continuous integration process. Technical documentation as well as sample code can be found here: https://bitbucket.org/meixxi/docs-plugin/wiki/Home