uwescience/shablona

pdoc as a documentation option

cranmer opened this issue · 1 comments

(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

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