[chirp_devel] chirp code auto documentation

[Tom Hayward]

On Mon, Jan 26, 2015 at 11:46 AM, Jens Jensen <af5mi at yahoo.com> wrote:
> Not sure if this has been discussed before, but one of the biggest
> challenges I think to new developers working with Chirp, e.g., radio
> drivers, is understanding some of the class structure (bitwise,
> chirp_common, settings, etc).
>
> I see alot of docstrings, etc in many common parts of the codebase, but I
> dont see anywhere this is rendered out to something a little more visually
> friendly.
>
> I'm wondering if there is any advantage to adopting something like this,
> e.g., rtfm, doxygen, readthedocs, etc?
>
> example of nice readthedocs:
> http://docs.locust.io/en/latest/api.html

This is a great idea. I just imported Chirp into readthedocs...
http://chirp.readthedocs.org/en/latest/

It's a little boring so far! I guess we need to point readthedocs to
some existing docstrings. I'm not familiar with this process.

Let me know your readthedocs username and I'll add you as a maintainer.

Tom KD7LXL