Feature request: Documentation for the library

[kirtanp]

I have started using SEML recently, and I have often had to parse through the source code to figure out the behaviour of some functions, what flags I have available, etc. It would be nice, and not too hard to make more detailed documentation (or have I missed that it already exists or is in the works?).

If it's not already being done and if you agree that's it's a reasonable thing to do, I would be willing to do it and send a PR. There are a couple of nice options for the docs which would make them easy to maintain

• https://docs.readthedocs.io/en/stable/tutorial/
• https://docsify.js.org/#/?id=docsify

My personal preference is readthedocs, but curious to hear your thoughts on this.

[gasteigerjo]

Indeed, the only documentation we currently have is the examples folder. Proper documentation has been on our to-do list ever since we started with SEML, but we never got around to actually doing it.

So please do go ahead and start with this! I'd be thrilled to accept any help!!

I agree on using readthedocs. It seems like the de-facto standard for most Python documentation.

[kirtanp]

Great! I will get on it towards the end of this month then and will hopefully have a PR in Feb. Will be in touch to ask more questions later this month!