[Bigbang-dev] Documentation organization

[Sebastian Benthall]

I see now that my reply to Nick on this wasn't reply-all. My bad!

> Can Sphinx accept some extra text/context in the index page of the
autogenerated library docs?
The answer to this is actually Yes.

This is the file that configures that page:
https://github.com/datactive/bigbang/blob/main/docs/api-docs.rst

Glad to see issue #502

I'm wondering if we should take the opportunity to think about the
submodule structure of the code and come to some consensus around it.
Christoph has introduced some new submodule structure to the code, which is
all quite welcome, but now we have some inconsistencies that it would be
good to work out before committing to in our documentation.

A couple issues connected with this:

https://github.com/datactive/bigbang/issues/435
https://github.com/datactive/bigbang/issues/498
https://github.com/datactive/bigbang/issues/414

We now have 'analysis' and 'visualization' submodules.
Maybe we should have an 'ingress' submodule and put the various mailing
list scrapers in there?



On Mon, Nov 22, 2021 at 2:59 PM Christoph Becker <chrbecker01 at gmail.com>
wrote:

> > I have noticed that documentation on development (running tests, code of
> conduct, formatting, etc.) isn't included in the Readthedocs pages yet. Is
> that something we want to move over? Or do we think of the readme as
> primarily for bigbang developers and readthedocs as primarily for bigbang
> users?
> Yes, the documentation on development should be part of the Readthedocs
> too, but we simply haven't had the time yet to polish and include it.
>
> > The API documentation is organized by file/library, which makes sense,
> but I'm not sure how easy that is for people to understand. Should we have
> an overview of how the code is organized so that someone new to the project
> knows what to look for where? E.g. mailing list crawling is done within
> these 4 files, archives and analysis is in these, these files were
> experimental and aren't regularly used, etc.
> Yes, that sounds good to me :) Could you create a PR for that?
>
> > Can Sphinx accept some extra text/context in the index page of the
> autogenerated library docs?
> I don't think so, but might be wrong.
>
> BW,
> Chris
>
>
> Op vr 19 nov. 2021 om 14:24 schreef Nick Doty <npdoty at ischool.berkeley.edu
> >:
>
>> Thanks Seb for getting this going! It's so nice to read documentation in
>> this format, rather than spread haphazardly around readme and wiki pages.
>>
>> 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.
>>>
>>
>> I'm fine with option (a). I have noticed that documentation on
>> development (running tests, code of conduct, formatting, etc.) isn't
>> included in the Readthedocs pages yet. Is that something we want to move
>> over? Or do we think of the readme as primarily for bigbang developers and
>> readthedocs as primarily for bigbang users?
>>
>> The API documentation is organized by file/library, which makes sense,
>> but I'm not sure how easy that is for people to understand. Should we have
>> an overview of how the code is organized so that someone new to the project
>> knows what to look for where? E.g. mailing list crawling is done within
>> these 4 files, archives and analysis is in these, these files were
>> experimental and aren't regularly used, etc. Can Sphinx accept some extra
>> text/context in the index page of the autogenerated library docs?
>>
>> —npd
>> _______________________________________________
>> Bigbang-dev mailing list
>> Bigbang-dev at data-activism.net
>> https://lists.ghserv.net/mailman/listinfo/bigbang-dev
>>
> _______________________________________________
> 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/20211123/06e532b1/attachment.htm>