[GeoNode-devel] Source Code Docs

[Patrick Dufour]

All,

What are your thoughts on adding richer resStructedText
(http://sphinx-doc.org/rest.html) documentation to the GeoNode source
code?  We have okay higher level docs but are missing lower level
docs.  The source code docs could be easily included with our Sphinx
build.

Better source code documentation would help new contributors.

For example: https://github.com/GeoNode/geonode/blob/master/geonode/layers/models.py

Should we document at the file, class, or function level?

My preference is to start at just the file level.  Function-level
documentation, implemented properly, might be taking on too much.

Regards,
Patrick