search

bloomberg / blazingmq

A modern high-performance open source message queuing system
https://bloomberg.github.io/blazingmq/
Apache License 2.0
2.53k stars 130 forks source link

Python SDK API Documentation showing spurious "page not found" errors. #162

Closed pniedzielski closed 9 months ago

pniedzielski commented 9 months ago

Is there an existing issue for this?

Current Behavior

When performing 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

Expected Behavior

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

Steps To Reproduce

This should be reproducible with the link above.

BlazingMQ Version

HEAD

Anything else?

This issue was reported in the Python SDK as https://github.com/bloomberg/blazingmq-sdk-python/issues/11. The Python SDK documentation is hosted in this repository, so fixing it will involve a code change to the Python SDK codebase along with a PR here.

Ultimately it will make more sense to host the Python API docs on GH pages in the Python SDK repo.

pniedzielski commented 9 months ago

In fact this only requires a change in the BlazingMQ repository, not with the Python SDK.

pniedzielski commented 9 months ago

Fixed with #168 .