search

tobymao / saq

Simple Async Queues
https://saq-py.readthedocs.io/en/latest/
MIT License
576 stars 39 forks source link

Version mismatch in documentation #136

Closed Seemone closed 2 months ago

Seemone commented 2 months ago

Documentation version mentions 0.12.3 as latest, but SAQ has 0.13.3

tobymao commented 2 months ago

i'm not sure how to fix this

tobymao commented 2 months ago

@grigi could you help me figure out and fix this? i don't know how docs are deployed or why they aren't updating.

grigi commented 2 months ago

Hi, you need to authenticate with readthedocs and install a commit hook. Since the github repo is owned by you, I can't add it. I can only manually click the build button (which I have been doing irregularly).

Please log in to: https://readthedocs.org/ (Your user has been added to the project already, so you should have access)

Go to https://readthedocs.org/dashboard/saq-py/integrations/ and setup a github integration. Make sure to select this project as a build trigger, and it should then auto-build on every push to master.

Edit: They have docs to do it here: https://docs.readthedocs.io/en/stable/guides/setup/git-repo-automatic.html

grigi commented 2 months ago

I did manually click the build docs option, but I see a lot of features have been added (like using Postgres as a queue). I'll see if I have time to update some of the docs, but the PG feature changes a lot of assumptions made before.

tobymao commented 2 months ago

@grigi i changed the master branch to main, and i think i broke the read the docs, can you take a look?sorry about that

tobymao commented 2 months ago

@grigi ok i think readthedocs finally updated their ui

grigi commented 2 months ago

Hi @tobymao seems that their UI took a while to realise a new branch exists.

You still need to setup the Github integration. Either go to https://readthedocs.org/accounts/3rdparty/ and setup github integration directly.

or

Go to https://github.com/tobymao/saq/settings/hooks/new and enter the url and secret from https://readthedocs.org/dashboard/saq-py/integrations/278319/ And instruct GitHub to use that webhook when an update to main happens.

This should setup readthedocs to automatically have up-to-date docs.

If you need to you're welcome to delete the webhook I setup.

tobymao commented 2 months ago

ok, i set up the web hook, i'm not sure which webhook you set up.

grigi commented 2 months ago

Sweet! Hopefully documentation is now automated for the future :+1: