Improved documentation
yifanwu opened this issue · 0 comments
yifanwu commented
Based @saulshanabrook's PR #412
What: Improved documentation: (1) TOC or be split into multiple files to be browsed more easily. (2) refer to code directly, instead of linking to the source code they are defined in.
Why: Our document is very large and has some links between it, and is hard to read and keep consistent.
Possible Approaches: One way we could improve it is by using Sphinx and Juptyer Book to build documentation. We could also then use the autodoc feature to pull in docstrings of modules and function.