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

Documentation showing spurious "page not found" errors. #11

Closed
gmc444-b opened this issue Dec 6, 2023 · 3 comments
Closed

Documentation showing spurious "page not found" errors. #11

gmc444-b opened this issue Dec 6, 2023 · 3 comments
Assignees
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@gmc444-b
Copy link

gmc444-b commented Dec 6, 2023

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.

@pniedzielski pniedzielski self-assigned this Dec 6, 2023
@pniedzielski pniedzielski added bug Something isn't working documentation Improvements or additions to documentation labels Dec 6, 2023
@pniedzielski
Copy link
Collaborator

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.

@pniedzielski
Copy link
Collaborator

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.

@pniedzielski
Copy link
Collaborator

Fixed with bloomberg/blazingmq#168

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

No branches or pull requests

2 participants