[Doc][Retro Item] Cw add autodoc

broadinstitute / cromwell-tools

A collection of Python clients and accessory scripts for interacting with the Cromwell

https://cromwell-tools.readthedocs.io

BSD 3-Clause "New" or "Revised" License

22 stars 9 forks source link

[Doc][Retro Item] Cw add autodoc #30

Closed rexwangcc closed 6 years ago

rexwangcc commented 6 years ago

This PR adds Sphinx-based Autodoc to pipeline-tools, it will also enable our developer docs to be shown on readthedocs.io

[x] Update docstrings for Sphinx.
[x] Add config files and makefile for Sphinx.
[x] Hook up to readthedocs.io

Please ensure the following when opening a PR:

[ ] Added or updated tests
[x] Updated documentation
[x] Applied style guidelines
[x] Considered generalizability beyond our own use case

rexwangcc commented 6 years ago

@ambrosejcarr @samanehsan Thanks for the comments and review! @ambrosejcarr In order to hook up this repo to rtd, I might need your help to remove/rename this existing doc site Besides, do you want me to postpone merging this PR? Since you have a much larger PR currently in this repo, which is not easy to rebase according to this docs update.

ambrosejcarr commented 6 years ago

@rexwangcc Done, sorry for the wait.