search

thedataincubator / congress-api

2 stars 5 forks source link

Documentation #4

Open dzbee opened 6 years ago

dzbee commented 6 years ago

Docstrings for the various classes and functions. README for installation.

ZachGlassman commented 6 years ago

Lets also set up something like Sphinx

johnmarcampbell commented 6 years ago

I can write some documentation. Is there any direction besides making it Sphinx compatible?

(I'm from the DC cohort - @John Campbell on Slack)

dzbee commented 6 years ago

There's thorough PEP conventions on docstrings: https://www.python.org/dev/peps/pep-0257/

Let's try to conform to those as much as we reasonably can.

dzbee commented 6 years ago

There's also a nice answer on SO about docstring conventions and different documentation generators including Sphinx: https://stackoverflow.com/a/24385103/1714512