Official docs not updated for 1.3.0, 1.3.1

[Gary H]

The documentation for pika on readthedocs.io (https://pika.readthedocs.io/en/stable/index.html) is outdated. Nothing more recent than 1.2.1 is available; it looks like 1.3.0 and 1.3.1 are both missing (and both stable & latest point to these 1.2.1 docs).

The result of this is that, in some cases, information is missing. For example, the documentation for BlockingConnection.process_data_events() on the website is missing some (arguably important) additional information about long-running publisher connections that is present in-source in the 1.3.1 tag.

Online docs:

https://pika.readthedocs.io/en/stable/modules/adapters/blocking.html#pika.adapters.blocking_connection.BlockingConnection.process_data_events

Source code:

https://github.com/pika/pika/blob/1.3.1/pika/adapters/blocking_connection.py#L821

Are there plans to update the documentation to include the docs for these newer versions, and ideally default stable to 1.3.1 and latest to something like main?

[Luke Bakken]

Hello,

Thanks for pointing this out. I'll take care of it. I create Pika releases so infrequently that I must have forgotten that readthedocs.io is a manual process.

Luke

[Luke Bakken]

Hmmm seems like readthedocs has an issue building the documentation ever since I moved from setup.py to the toml file. I'll fix it. Thanks again for pointing this out.

git clone --no-single-branch --depth 50 https://github.com/pika/pika.git .

git checkout --force 6dd6f7b100425e835ad363ef1b96786d0ff8389e

git clean -d -f -f

python3.7 -mvirtualenv $READTHEDOCS_VIRTUALENV_PATH

python -m pip install --upgrade --no-cache-dir pip setuptools<58.3.0

python -m pip install --upgrade --no-cache-dir pillow mock==1.0.1 alabaster>=0.7,<0.8,!=0.7.5 commonmark==0.9.1 recommonmark==0.5.0 sphinx<2 sphinx-rtd-theme<0.5 readthedocs-sphinx-ext<2.3 jinja2<3.1.0

python /home/docs/checkouts/readthedocs.org/user_builds/pika/checkouts/1.3.0/setup.py install --force

/home/docs/checkouts/readthedocs.org/user_builds/pika/envs/1.3.0/bin/python: can't open file '/home/docs/checkouts/readthedocs.org/user_builds/pika/checkouts/1.3.0/setup.py': [Errno 2] No such file or directory

[Luke Bakken]

Whew, a few issues had to be fixed since I also ran into this - https://github.com/readthedocs/readthedocs.org/issues/10290

"latest" just built successfully, and I'm getting the other versions as well - https://pika.readthedocs.io/en/latest/

[Luke Bakken]

OK, last response.

In order to fix the docs build for the 1.3.x branch, I had to release version 1.3.2, which I will announce soon

https://pika.readthedocs.io/en/1.3.2/

Thanks for using Pika and RabbitMQ.

Luke

[Gary H]

Many thanks for the quick action! Glad you were able to get it straightened out.