docs: Include Sphinx JS for Python SDK docs #163
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
When running a search within the Python SDK docs, the synopsis for each match is a file not found error message. The root cause of this is that the Sphinx Javascript file `_static/_sphinx_javascript_frameworks_compat.js` does not seem to be copied by GitHub Pages’ Jekyll processor. This is likely due to the fact that its filename begins with an underscore, which causes Jekyll to treat it as a special file, not to be copied literally. We saw this problem generally before the fix in commit 37bf5a9, as the `_static` directory was not being included. This patch adds an explicit include for the Sphinx Javascript file, teaching GitHub Pages to include it in its output verbatim. Signed-off-by: Patrick M. Niedzielski <[email protected]>
pniedzielski
added
documentation
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When running a search within the Python SDK docs, the synopsis for each match is a file not found error message. The root cause of this is that the Sphinx Javascript file
_static/_sphinx_javascript_frameworks_compat.jsdoes not seem to be copied by GitHub Pages’ Jekyll processor. This is likely due to the fact that its filename begins with an underscore, which causes Jekyll to treat it as a special file, not to be copied literally. We saw this problem generally before the fix in commit 37bf5a9, as the_staticdirectory was not being included.This patch adds an explicit include for the Sphinx Javascript file, teaching GitHub Pages to include it in its output verbatim.
Issue number of the reported bug or feature request: #162
See also bloomberg/blazingmq-sdk-python#11