agronholm / apscheduler

Task scheduling library for Python
MIT License
5.98k stars 694 forks source link

404 Not Found when accessing the API reference from `master` version to any other version #855

Closed achieveordie closed 6 months ago

achieveordie commented 6 months ago

Things to check first

Version

master

What happened?

The documentation link from the README directs us towards https://apscheduler.readthedocs.io/en/master/, i.e. the master version of the docs, if we open the API reference and then try to switch to different versions (stable, 3.x, latest) we get a 404.

This is happening because the path for the previous versions was /py-modindex (eg: https://apscheduler.readthedocs.io/en/latest/py-modindex.html) whereas the master version has /api (https://apscheduler.readthedocs.io/en/master/api.html#).

There's a redirect missing which would switch from api to py-modindex in case older versions are accessed.

How can we reproduce the bug?

I'm mentioning the exact steps to follow for further clarity:

Steps to follow:

  1. Visit the link https://apscheduler.readthedocs.io/en/master/ from README.
  2. Click on the API Reference tab on the left.
  3. Change to any other version from the bottom left corner: image
  4. Voila, 404 not found: image
agronholm commented 6 months ago

The API reference is structured differently in v3 and v4, so you need to first go to the index, switch versions and then click on the API reference.