documentation generation

[zargot]

Use Sphinx to generate documentation via github actions.

• Include quarto docs, converted to markdown.
• Add a project/config file for Quarto, so that we can render all quarto-parts with a single Quarto command.
• Make sure that the readme link anchor works (after spec: fix readme links #75).

[zargot]

It seems like Doxygen has support for python, and that the github-actions marketplace has good support for it. Should I go ahead with that or did you have something else in mind, @DougManuel @yulric ?

[zargot]

Something tells me Sphinx is a more popular choice. It seems to have good support as well.

[DougManuel]

I only have a bit of experience with Doxygen - which I like. I'll defer to others.

[yulric]

Personally, I would go with Sphinx, it looks nicer haha. We'll need to decide what we want to include in the doc site for this package. Currently, I think we need the API docs and the how to tutorial. Ideally, whatever doc builder we use has support for including different documentation parts into one website.

[zargot]

I'll give Sphinx a try

[zargot]

I've updated the issue description to reflect that we're gonna write everything in Quarto and abandon Sphinx. The reason for this is to reduce complexity and make it better in general, as a mix of two doc-generation tools became messy. A new issue has been made to handle generation of the Python package API (#76).

Never mind, my bad. We will continue with Sphinx to avoid #76.