Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
1 task done
pniedzielski opened this issue Dec 6, 2023 · 2 comments
Closed
1 task done
Assignees
Labels
A-Docs Area: Documentation bug Something isn't working documentation Improvements or additions to documentation

Comments

@pniedzielski
Copy link
Collaborator

Is there an existing issue for this?

  • I have searched the existing issues

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 bloomberg/blazingmq-sdk-python#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 pniedzielski added the bug Something isn't working label Dec 6, 2023
@pniedzielski pniedzielski self-assigned this Dec 6, 2023
@pniedzielski pniedzielski added documentation Improvements or additions to documentation A-Docs Area: Documentation labels Dec 6, 2023
@pniedzielski
Copy link
Collaborator Author

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

@pniedzielski
Copy link
Collaborator Author

Fixed with #168 .

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-Docs Area: Documentation bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant