Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Publish docs #29

Open
susuhahnml opened this issue Feb 12, 2024 · 4 comments
Open

Publish docs #29

susuhahnml opened this issue Feb 12, 2024 · 4 comments

Comments

@susuhahnml
Copy link
Collaborator

  • Action to publish documentation
  • A link to the docs in the readme
@MaxOstrowski
Copy link
Member

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
Copy link
Member

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
Copy link
Member

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
Copy link
Member

sthiele commented Feb 22, 2024

Is this better with readthedocs ?

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants