docstring style for mkdocstrings

[ssweber]

I'm planning on using mkdocs / mkdocstrings. Once we have them ready, we can easily host via github pages.

In order to get mkdocstrings working correctly, I'll need to do some docstring reformatting (last time I promise). Our sphinx-style are missing :type, so this is a good time to reformat.

We have three options of docstring styles:

I personally prefer either the google or numpy style. They read alot better in the code. See here

Once that is done, the generated site will look like:

[ssweber]

Looks like it also grabs type information from the function, so this:

is generated without having to duplicate our types:

[ssweber]

NVM! I didn't have the mkdocs config correct. Got it working with sphinx style. And we don't need the :type to get them working.

[PySimpleSQL]

Yeah, I thought the :type was optional. I think the doc strings are looking pretty decent finally. What are your thoughts on the formatting now?

…

On Wed, Apr 5, 2023, 3:34 PM ssweber ***@***.***> wrote: NVM! I didn't have the mkdocs config correct. Got it working with sphinx style. And we don't need the :type to get them working. — Reply to this email directly, view it on GitHub <#251 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AQX2RESQWESLBYF2IXZN353W7XCNFANCNFSM6AAAAAAWUOZJV4> . You are receiving this because you are subscribed to this thread.Message ID: ***@***.***>

[ssweber]

I think they look great.

I was just confused initially, learning about how to do mkdocs and mkdocstrings to host.