Standalone / static .html output

[GaryJones]

Tangentially related to #14.

I'd like to have the option of generating a bunch of static .html files (like phpDocumentor or ApiGen would do) from the .json output. This could then be used to create a docset for Dash (one exists for WP core, but I'm thinking of doing it for a theme) or some other standalone / offline documentation system that doesn't allow a full install of WP.

[Rarst]

Thinking aloud — we already pull in like good chunk of PhpDocumentor, might make sense to just send the data with WP extras back to it.

[atimmer]

Completely support this, this would improve the decoupling between DevHub and WP-Parser as projects.

[GaryJones]

What's actually needed for this? A renderer with a template for single entries, then a parent template with iframe for navigation?

[Rarst]

I think the logical attempt would be to install PhpDocumentor and see what needs to happen to be able to plug WP Parser extras into it from that side.

[Rarst]

So from this and some more discussion the current plan is to try implement "backstream" compatibility of sorts — try to achieve WP Parser providing its specific logic to phpDocumentor.

I will be exploring this as part of improving API documentation for Yoast projects.

Hadn't used phpDocumentor in a while, so I guess step one would be to get latest version running and start figuring out how to plug WP hooks into it.

[GaryJones]

I'd like to be all professional and say thank you Rarst for taking this on, but...

Woohoo! 🎉 🎈 🍻

[remcotolsma]

We at Pronamic were also looking for a way to document the WordPress filters and actions in our WordPress plugins, themes and libraries. In our search we came across a number of solutions, for our research see the following issue: pronamic/wp-pay-core#45. In the end we developed a solution ourselves: https://github.com/pronamic/wp-documentor. It can find all WordPress actions and filters in a codebase. The result can be converted to a markdown file for in your Github repository or GitHub Pages. See for example: https://github.com/pronamic/wp-documentor/blob/main/tests/docs/hooks.md. Unfortunately there is not yet the possibility to generate a separate page for each hook.