Automated documentation for PRESTO?

[astrogewgaw]

Just wanted to know if anyone has tried to serve Doxygen-based documentation for PRESTO? Nowadays there are packages that can link Doxygen output with Sphinx to generate documentation that could be hosted on platforms like Read The Docs: for example, projects like breathe or exhale. I wanted to try my hand at this in my free time, and wanted to know if this is something that people would like, or had already tried.

[scottransom]

The biggest problem is that the raw doc-strings that will be converted into nice "real" documentation don't exist! If you (or others) want to write real documentation, I would gladly appreciate the help!

[astrogewgaw]

Sure, I will see what I can do! As far as the raw doc-strings are concerned, I think people who have contributed code to PRESTO could be a great help, since they will probably have some idea about PRESTO's internals. I am assuming that the raw doc-strings can be added incrementally, even as an automated system to generate and publish the docs is put in place. If I can come up with something that works, I will submit a PR 😁 !