pacificclimate / climpyrical

A Python tool for constraining and manipulating CanRCM4 climate models.
GNU General Public License v3.0
1 stars 0 forks source link

Generate Documentation Website from Docstrings #31

Closed nannau closed 4 years ago

nannau commented 4 years ago

When contributing to PyKrige, I noticed that their documentation on their website was automatically updated with the docstrings I helped write. climpyrical will need attention put towards documentation, and there is too much information about it for a single README.

A "readthedocs" style website like this would be very cool with climpyrical, particularly if its automated.

It looks like some tools exist to help with this alread: https://readthedocs.org/

And https://github.com/docsifyjs/docsify

GitHub provides free static website hosting, so that seems like the logical place to host it.