-
-
Notifications
You must be signed in to change notification settings - Fork 161
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
Serving documentation with a simple server. #2676
Conversation
Wasn't really sure whether I should and stubs, as I was changing the part of code without it, but I guess that it isn't that bad idea. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm now thinking we could just make it so that py -m pygame.docs
creates a local server and opens it in the browser by default. This change shouldn't be too disruptive right?
It shouldn't, but I didn't want to change the default behavior. |
I'm fine with changing behaviour for this specific case, but let's wait for what others would say and then accordingly move this PR forward |
What about changing the default behavior on Linux only? That way we can test it out as the default without risking it breaking for as many people. |
@Starbuck5 It probably will be confusing for some people, but I can re-implement this in the way that one can use |
…it simple file opening.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Left a review, but apart from that this PR LGTM.
Thanks for the PR 🥳
Can someone rerun the test? |
Running now |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM 👍
Serving documentation with a simple server.
As discussed in here running
python -m pygame.docs
in some circumstances may fail - when a default browser is a non-classic snap package andpygame-ce
library is installed in a.hidden
folder (dotted), as those folders snaps can't access. This pull request solves this issue by introducing another method of opening documentation - running a simple local server for this purpose (withpython -m pygame.docs.serve
) while not changing the original behavior.