Get rid of docscomments.js from docs #2959
Merged
Conversation
This file contains hidden or 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
damusss
reviewed
Jun 29, 2024
ankith26
approved these changes
Jul 7, 2024
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.
In
docs/reST/classic/elements.htmlthis element is included in the file:<script type="text/javascript" src="https://www.pygame.org/comment/jquery.plugin.docscomments.js"></script>.However this file isn't necessary and it is also fetched from the original pygame website. This was probably forgotten when the pygame-ce fork was made.
I ran
py -m setup.py docsand can confirm that the documentation still works when the script is removed.Here are some screenshots with the file removed:
Credits to @mzivic7 from pygame community server for pointing this out and @oddbookworm for realizing that it's not needed.