Contributing#

Attention

This page still a work in progress.

Python and Cython#

todo

Project organization#

todo

Docstring conventions#

https://numpydoc.readthedocs.io/en/latest/format.html

Website#

TODOs#

  • release PDF version of docs with each library verison/release?

  • page on “anatomy of an H3 index”

Other projects with nice docs#

For reference, here are some other projects whose docs we should consider when styling our own: