Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

How to import phpDoc into Confluence?

I'm looking for proper way to use phpDoc-comments from project to generate developer's documentation inside my Confluence 4.1.4.

like image 224
DrSat Avatar asked Jan 17 '23 11:01

DrSat


2 Answers

One approach I've been looking at is to deploy my HTML output (similar to phpDoc) as a second web app on Confluence's instance of Tomcat, and then to iFrame that doc into a Confluence page. It doesn't integrate with Confluence's searching/indexing or labelling, but it should play nicely with the Crowd authentication scheme that we've set up. I figure I could then use a federated search tool to search across the two web apps.

like image 180
danger4242 Avatar answered Jan 24 '23 20:01

danger4242


I'm looking for the same solution. The closest I have come is using html2wiki which has a dialect for Confluence. I created a PHP script that recurses through my api directory and processes each html page with this html2wiki program. Unfortunately, it does not perfectly format the markup and leaves undesired html artifacts.

My next approach is to try and tweak the dialect myself to try and resolve the poor formatting.

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

like image 37
Brett Avatar answered Jan 24 '23 19:01

Brett