[Bigbang-dev] Documentation [PR for Sphinx docs]

[Sebastian Benthall]

Hello,

It looks like I merged a few stub pages for the Sphinx documentation a few
weeks ago.
I've now connected ReadTheDocs and you can see the documentation website is
now live at:

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

This can be expanded in many ways, as I mentioned before.

- S

On Wed, Oct 6, 2021 at 11:48 AM Sebastian Benthall <sbenthall at gmail.com>
wrote:

> Hello,
>
> I'm requesting a review of this PR that introduces Sphinx documentation.
>
> https://github.com/datactive/bigbang/pull/491/
>
> This creates a new directory `docs/` with the machinery for building an
> HTML documentation website.
>
> ReadTheDocs is an on-line service for hosting these kinds of docs; I'll be
> hooking up this service next.
>
> The autodocs, meaning the documentation automatically produced from python
> docstrings, is supported in this PR. But there's a lot we can do to improve
> the docstrings in the code.
>
> There are also a number of things we can do to expand the documentation
> that's published on-line. For example, it's possible to import high quality
> Jupyter notebooks into the documentation website.
>
> I wanted to ask for eyeballs on this PR in particular and open the
> discussion to documentation more broadly.
>
> Best regards,
> Seb
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.ghserv.net/pipermail/bigbang-dev/attachments/20211006/54cd9d44/attachment.htm>