Open moeyensj opened 6 years ago
I think it's a good idea to adopt the sphinx-style format. A lot of the code is using the Google python doc style (which I am admittedly more familiar with) but would be happy to convert over to sphinx-style over time.
We briefly discussed this during the hack session but didn't decide on anything. Are we interested in using sphinx-style documentation hosted by a service like read the docs? If so, it could be good to agree on a comment / docstring / documentation standard and start using that from now on to make it easier for us later.
Here is an astropy example going from higher level documentation all the way to source code: http://docs.astropy.org/en/stable/ http://docs.astropy.org/en/stable/coordinates/index.html http://docs.astropy.org/en/stable/api/astropy.coordinates.SkyCoord.html#astropy.coordinates.SkyCoord.to_string http://docs.astropy.org/en/stable/_modules/astropy/coordinates/sky_coordinate.html#SkyCoord.to_string