search

scottransom / presto

Open source pulsar search and analysis toolkit
http://www.cv.nrao.edu/~sransom/presto/
GNU General Public License v2.0
235 stars 170 forks source link

Automated documentation for `PRESTO`? #177

Open astrogewgaw opened 1 year ago

astrogewgaw commented 1 year ago
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**](https://readthedocs.org/): for example, projects like [**`breathe`**](https://www.breathe-doc.org/) or [**`exhale`**](https://exhale.readthedocs.io/en/latest/). 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 commented 1 year ago

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 commented 1 year ago
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 😁 !