Closed fire closed 3 years ago
Is there a way to generate web-based documentation from the xml files? I imagine that's how the official godot documentation is generated, but I'm not sure the best course of action for a module. My original reasons for the duplication were:
I'll definitely roll the non-API documentation files into a proper readme, but I'd value some input on the above.
Not sure. I would try asking Xrayez in the godot-extended-libraries for this feature in modules.
I ended up going down this rabbit hole myself. It turns out that github supports .rst files in the wiki, which is the format that the xml documentation gets turned into for the official online docs. I made a dedicated project to test the following workflow using Github Actions, which can automatically trigger anytime a commit changes a file in the doc_classes folder:
With a handwritten main page and sidebar to pull it all together, this process could meet my goals of having web-based API documentation while also eliminating the manual duplication of those files.
That sounds great. Feel free to add the feature.
Here's a summary of the documentation improvements:
Currently there's two places where documentation is stored, that is bad because it means duplicated work.