Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Compiled API documentation #37

Open
danielk333 opened this issue Oct 1, 2021 · 1 comment
Open

Compiled API documentation #37

danielk333 opened this issue Oct 1, 2021 · 1 comment
Labels
documentation enhancement

Comments

@danielk333
Copy link

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
Copy link
Member

ryanvolz commented Oct 1, 2021

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation enhancement
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@ryanvolz @danielk333