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 😊
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.
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.
Ben Ramsey
in reply to Andrew Woods • • •It’s hosted on #ReadTheDocs, using their docs template and Sphinx to generate them.
https://readthedocs.org
The README in my docs folder goes into more detail: https://github.com/ramsey/uuid/tree/4.x/docs
uuid/docs at 4.x · ramsey/uuid
GitHubSenior Rabbit-Hole Explorer
in reply to Ben Ramsey • • •Jaapio
in reply to Senior Rabbit-Hole Explorer • • •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 😊
@awoodsnet
Ben Ramsey
in reply to Jaapio • • •Jaapio
in reply to Ben 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.
See our docs for examples
@heiglandreas @awoodsnet
Ben Ramsey
in reply to Jaapio • • •This is great to hear! I didn’t realize you had changed direction. I’ll have to check it out. Is it “production ready?”
Is there anyone like Read the Docs who are auto-building on pushes and hosting multiple versions of docs built with phpDocumentor?
RST is my preferred format for technical documentation, btw.
Jaapio
in reply to Ben 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.
reshared this
Mathias Bolt Lesniak reshared this.
Larry Garfield
in reply to Jaapio • • •