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

autodoc plugin for sphinx #210

Open
minrk opened this issue Apr 25, 2016 · 2 comments
Open

autodoc plugin for sphinx #210

minrk opened this issue Apr 25, 2016 · 2 comments

Comments

@minrk
Copy link
Member

minrk commented Apr 25, 2016

Perhaps related to #131, we should consider an extension to sphinx autodoc that would let you include trait info, such as types and help strings, in autodoc output.

This doesn't have to start in this repo, it can be a standalone extension, but I think it would be useful for things like generating good docs on what's configurable in a project.

@rmorshea
Copy link
Contributor

rmorshea commented Apr 27, 2016

@minrk, so far #131 pulls help text from TraitType.info(), lists the initial metadata, and shows a trait's associated event handlers. Is there more information that would be good to automatically generate?

@minrk
Copy link
Member Author

minrk commented Apr 28, 2016

I'm mainly thinking of generating a nice rst summary with type info and help strings. The mechanism will probably be similar, but the output will probably need to be a bit different, since it should do things like .. autoattribute::, etc., and indicate whether they are configurable, etc.

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

No branches or pull requests

2 participants