add api docs & instructions on use

RhodiumGroup / rhg_compute_tools

Tools for using compute.rhg.com and compute.impactlab.org

MIT License

1 stars 4 forks source link

add api docs & instructions on use #9

Closed delgadom closed 6 years ago

delgadom commented 6 years ago

this thing is complicated. let's show people how to use it!

delgadom commented 6 years ago

done. Refresh & test the API docs with

rm docs/rhg_compute_tools*.rst &&
    sphinx-apidoc -o docs rhg_compute_tools &&
    sphinx-build -W -b html -d docs/_build/doctrees docs/. docs/_build/html