Giters

bloomberg / blazingmq-sdk-python

Python SDK for BlazingMQ, a modern high-performance open source message queuing system.

Home Page:https://bloomberg.github.io/blazingmq/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Documentation showing spurious "page not found" errors.

gmc444-b opened this issue · comments

commented

Bug Report

I performed the following search in the Blazing MQ documentation: https://bloomberg.github.io/blazingmq/docs/apidocs/python_apidocs/search.html?q=thread&check_keywords=yes&area=default

The synopsis for each match is a file not found error message. But the link to the document works. Below is sample text from the search results.

Search Results

Search finished, found 3 page(s) matching the search query.

Examples
...Page not foundThe page you requested could not be found. Try using the navigation or search to find what you're looking for or go to this site's home page.Back to topCopyright © 2023 Bloomberg

blazingmq
...Page not foundThe page you requested could not be found. Try using the navigation or search to find what you're looking for or go to this site's home page.Back to topCopyright © 2023 Bloomberg

This should be reproducible with the link above.

Expected behavior/code

To only display the error if there's an actual error.

commented

It looks like the root problem of this is that the Sphinx javascript is not being found, even on the main page. Other files in this directory are being found. Jekyll has some hangups on files whose names begin with an underscore, so this may be the root cause.

Screenshot 2023-12-06 at 12 23 27 PM

The documentation for all Python SDKs is hosted in the main BlazingMQ repo, so I'll open an issue there and link it here as well.

commented

This was a bug in the ReadTheDocs Sphinx theme (see readthedocs/sphinx_rtd_theme#1507); building the docs from a new venv with sphinx_rtd_theme=2.0.0 fixes this issue.

Will make a new PR to main BlazingMQ with these changes.