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

pdoc as a documentation option #38

Open
cranmer opened this issue May 3, 2016 · 1 comment
Open

pdoc as a documentation option #38

cranmer opened this issue May 3, 2016 · 1 comment

Comments

@cranmer
Copy link

cranmer commented May 3, 2016

(preface: For shablona I realize it's a balance of being inclusive vs. opinionated on good practices.)

I like sphinx, but another nice option for documentation is doc an Automatic Python API documentation generation tool

http://pdoc.burntsushi.net/pdoc

https://wiki.python.org/moin/DocumentationTools
@arokem
Copy link
Contributor

arokem commented May 4, 2016

Thanks! For this one, I think we should err on the side of opinionated. But it's good to know about pdoc!

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

No branches or pull requests
2 participants
@arokem @cranmer