[Bigbang-dev] Automated documentation for BigBang -> Readthedocs

[Sebastian Benthall]

BigBang has made it this far without automated or standardized
documentation.

But based on the wider interest in the project and the calls to ease
onboarding, I'd like to make this a focus for the sprint.

I'll take responsibility for getting some documentation for BigBang up on
readthedocs

https://readthedocs.org/
https://github.com/datactive/bigbang/issues/412

A readthedocs page has many benefits.
 - A de facto landing page, explaining the purpose of the project, that is
more accessible than the GitHub repository
 - A navigable place to look for documentation and examples (and videos)
 - A way to publish API documentations and enforce style in docstrings

I've been doing a lot of work on RTD docs for a different project [1] and
so am prepared to take this on.

 Best regards,
Seb

[1] https://hark.readthedocs.io/en/latest/
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.ghserv.net/pipermail/bigbang-dev/attachments/20210226/283049af/attachment.htm>