<div dir="ltr">Hello,<div><br></div><div>It looks like I merged a few stub pages for the Sphinx documentation a few weeks ago.</div><div>I've now connected ReadTheDocs and you can see the documentation website is now live at:</div><div><br></div><div><a href="https://bigbang-py.readthedocs.io/en/latest/index.html">https://bigbang-py.readthedocs.io/en/latest/index.html</a><br></div><div><br></div><div>This can be expanded in many ways, as I mentioned before.</div><div><br></div><div>- S</div></div><br><div class="gmail_quote"><div dir="ltr" class="gmail_attr">On Wed, Oct 6, 2021 at 11:48 AM Sebastian Benthall <<a href="mailto:sbenthall@gmail.com">sbenthall@gmail.com</a>> wrote:<br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex"><div dir="ltr">Hello,<br><div><br></div><div>I'm requesting a review of this PR that introduces Sphinx documentation.</div><div><br></div><div><a href="https://github.com/datactive/bigbang/pull/491/" target="_blank">https://github.com/datactive/bigbang/pull/491/</a><br></div><div><br></div><div>This creates a new directory `docs/` with the machinery for building an HTML documentation website.</div><div><br></div><div>ReadTheDocs is an on-line service for hosting these kinds of docs; I'll be hooking up this service next.</div><div><br></div><div>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.</div><div><br></div><div>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.</div><div><br></div><div>I wanted to ask for eyeballs on this PR in particular and open the discussion to documentation more broadly.</div><div><br></div><div>Best regards,</div><div>Seb</div></div>
</blockquote></div>