[Bigbang-dev] Documentation organization

[Sebastian Benthall]

Hello,

New documentation us up on RTD, including autodocs for the code docstrings
and the README, imported.

https://bigbang-py.readthedocs.io/en/latest/

Now that we have a location to put more expansive/complete documentation,
we can have dedicated pages for issues, such as the data ingress/egress
<https://github.com/datactive/bigbang/issues/414> we support.

Currently, all of our documentation is in the README, which has gotten
quite long.

We have some options:
 - (a) move material out of the README into dedicated pages that are
rendered to the docs, keeping the README light, with "must have"
information and links to the docs for other topics.
 - (b) maintain information redundantly in the README and in Sphinx
 - (c) Status quo: keep using the README for almost everything except
autodocs.

My preference is for option (a).

I wonder how you all feel about the best way to organize the docs.

- S
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.ghserv.net/pipermail/bigbang-dev/attachments/20211008/cce6cd6a/attachment.htm>