search

WPRDC / wprdc-etl

MIT License
8 stars 3 forks source link

add-the-docs, fixes #18 #25

Closed bsmithgall closed 8 years ago

bsmithgall commented 8 years ago

@saylorsd feel free to check out this branch and run the commands in the README to take a look at what the final docs look like. I was planning on hosting them on readthedocs.org, but that site appears to be having some trouble ATM with their SSL certificates. I'm not totally sure what good alternatives might be.

saylorsd commented 8 years ago

:+1: Love it! Am I right in assuming that most of the future upkeep for this will lie in writing proper docstrings?

bsmithgall commented 8 years ago

Yes. It uses sphinx to do documentation. There's two parts to the documentation, the API (which is largely done for now and documented via docstrings), and the actual "what are these pieces and how do I use them" bit, which is mostly under construction and will be written when things are a bit more stable (i.e. we've moved everything around).