@heiglandreas thanks Andreas, I think @ramsey is aware of phpDocumentor. But maybe not of the ability to render markdown and restructured text. Sphinx does a great job. But phpDocumentor is faster, and written in #php 😊
@ramsey it was, about 8 years ago we changed our goal. phpDocumentor will be a documentation framework. That's what we are working on right now. since 1 year we have had full support for RST. Markdown is still experimental, but also ready to be tested by end users.
I will keep building on this until we have the ultimate documentation tool for php. That can generate uml diagrams out of code, and fully integrates api docs with developer docs.
@jaapio how hard would it be to phpDocumentor for parsing Shell doc comments too? There isn’t a good solution currently. I like the style of phpdoc, but naturally would need to adapt some of the items for shell scripting?
@awoodsnet that would require another parser. In theory it's just that, but I never tried to build a second one.
We do a lot of reflection in php. Trying different type resolution strategies. Not sure a complex tool like phpDocumentor would be the best fit for bash
@awoodsnet@jaapio@heiglandreas I’m not sure whether there’s a standard for that, but I’ve noticed JetBrains IDEs parsing them and showing their details when hovering over functions, etc.
@ramsey it's production ready. The RST parser is a collaboration with the #Typo3 documentation team. They recently switch to our parser completely.
phpDocumentor itself doesn't contain the latest version yet. I expect a new release somewhere this month. Since 3.3 it's really usable.
We do have a GitHub action so it's easy to integrate in your pipelines. No hosted solution right now. But maybe that will follow in the future. Might be a nice idea. However GitHub pages also works.
Add comment