Add API docs and install instructions to README

[NickleDave]

Hi @monocongo just raised that issue related to the pyOpenSci review as discussed here: https://github.com/pyOpenSci/software-submission/issues/111#issuecomment-1591996074

Before we can start the review we'll need

• [ ] API docs, e.g. generated with autodoc
• [ ] brief install instructions in the readme (can be as simple as pip install climate_indices

Just let us know when you have a chance to take care of those and we'll get you that review, thank you!

[monocongo]

I have detailed installation instructions available now, and trying to get the API docs finished with autodoc, hopefully in the next day or so. This has led me to consider a revamp of the project docs. Is there an example project that has a good README.md and/or index.rst I can use as a template? Please advise if there's a "model citizen" project in the pyOpenSci community I can emulate.

[NickleDave]

Hi @monocongo thanks for letting me know.

Is there an example project that has a good README.md and/or index.rst I can use as a template?

Good question.
All the packages are listed here and their READMEs should give you an idea of what we look for.
https://www.pyopensci.org/python-packages.html I'm hesitant to say who a "model citizen" would be although I think we could add some recommendations to our guide. My own opinion, not pyOpenSci's:

• pynteny has a good README: https://github.com/Robaina/Pynteny
• see also devicely: https://github.com/hpi-dhc/devicely
• I like how PyGMT does their docs, notice how they just include README.rst so the two don't go out of sync: https://raw.githubusercontent.com/GenericMappingTools/pygmt/main/doc/index.rst (you could do the same thing with a README.md if you used MyST)

Does that help?

[monocongo]

Yes, helpful guidance, thanks @NickleDave !