Generate and deploy docs

[suvayu]

• API docs: include multiple versions: master, latest & past releases #100
• Installation instructions & developer docs #101
• Reformat docstrings to numpydoc #99

[HannoSpreeuw]

After consulting @suvayu: we'll go for Sphinx.

We also discussed uniform formatting of docstrings.
If I understood correctly, this seems to be a requirement.
That would be numpydoc.

So how to proceed? First convert all PySE docstrings to this format?
Could that be done with a little AI help, i.e. some plugin like GH Copilot for my IDE (PyCharm)?

Or work on the deployment of Sphinx first and align the docstrings later?

[suvayu]

So how to proceed? First convert all PySE docstrings to this format?
Could that be done with a little AI help, i.e. some plugin like GH Copilot for my IDE (PyCharm)?

Unfortunately I have not found a good way to do this easily. I tend to do it all manually. So do whatever works for you. I would say focusing on the docstrings is more important now. I'll figure out the sphinx setup and how to organise (technically) the hand written docs (like tutorials, or how tos). Then we can deploy the docs and iterate.

[HannoSpreeuw]

Okay. I can do that, i.e. convert all the docstrings to align with numpydoc.

I created a documentation branch locally.