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.

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

API reference documentation #88

Open
AuHau opened this issue Dec 20, 2018 · 0 comments
Open

API reference documentation #88

AuHau opened this issue Dec 20, 2018 · 0 comments

Comments

@AuHau
Copy link
Owner

AuHau commented Dec 20, 2018

Currently, there is no detailed API wrapper's reference, where detailed signatures are explained for the wrapper classes.

There are few criteria from my side:

  • Needs to be generated from doc-strings (otherwise it will get stale very fast as people are lazy to update hand-written reference, me included).
  • Needs to be compatible with mkdocs (I am not a big fan of reST and Sphinx).

Currently, I am aware of pydoc-markdown, but the current version does not support documentation of class's attributes. There is a new version being developed which will support it but for now, I am not aware of any other solutions, so if you know about any please let me know!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant