[Bigbang-dev] Documentation organization

Christoph Becker chrbecker01 at gmail.com
Tue Oct 19 19:35:51 CEST 2021


Hi Seb & Co.,
I have made some suggestions via a PR on the repo:
https://github.com/datactive/bigbang/pull/495

Greetings,
C


Op ma 18 okt. 2021 om 16:19 schreef Sebastian Benthall <sbenthall at gmail.com
>:

> Hello,
>
> I've made some updates to the documentation organization.
>
> https://bigbang-py.readthedocs.io/en/latest/index.html
>
> Happy to get any feedback.
>
> - S
>
> On Fri, Oct 8, 2021 at 4:11 PM Sebastian Benthall <sbenthall at gmail.com>
> wrote:
>
>> 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
>>
> _______________________________________________
> Bigbang-dev mailing list
> Bigbang-dev at data-activism.net
> https://lists.ghserv.net/mailman/listinfo/bigbang-dev
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.ghserv.net/pipermail/bigbang-dev/attachments/20211019/b8889b1d/attachment.htm>


More information about the Bigbang-dev mailing list