Compiled API documentation

MITHaystack / digital_rf

Read, write, and interact with data in the Digital RF and Digital Metadata formats

Other

97 stars 30 forks source link

Compiled API documentation #37

Open danielk333 opened 2 years ago

danielk333 commented 2 years ago

Most of the python and c code has well structured in-code documentation but its not compiled anywhere, at least where I can easily find it. This mean one has to open up the library source code to look up the API-description. Maybe a simple sphinx/doxygen run could generate the HTML and github-pages could serve them?

Just a suggestion for enhancement :)

ryanvolz commented 2 years ago

Yeah, I definitely want to get sphinx going and upload the result to Read the Docs.