Publish docs

[susuhahnml]

• Action to publish documentation
• A link to the docs in the readme

[MaxOstrowski]

With readthedocs there is apparently also the possibility that the actionn is triggered on their side whenever the git is updated.
That sounds nice, but also means that the setup needs to be done on readthedocs. Don't know what is better.

[rkaminsk]

I read up a bit on this. It seems like we have have to configure the build on readthedocs if we want to use their service. If we want to use github actions, we have to roll our own thing and deploy to github pages.

I am in favor of using what readthedocs provides because it supports versioning. Like this we'll preserve a documentation history. Reproducing this using github actions would be cumbersome.

[MaxOstrowski]

I'm ok with whatever works best. I personally am always very annoyed by versioned documentation, as search engines tend to show old versions.
So searching for "clingo api" on duckduckgo gives me the first link:
https://potassco.org/clingo/python-api/5.4/
which is very outdated. Is this better with readthedocs ?

[sthiele]

Is this better with readthedocs ?

At least with readthedocs there is an easy way to jump to the latest version.

[nrueh]

I added a doc.yml file in the github-pages branch for automatically publishishing to Github Pages.

But there seems indeed to be no easy way to have versioning of documentations.
The closest I found was this but I did not get it to work and I think it uses an approach to Github Pages where the documentation is created in a separate branch which I did not like that much.