-
-
Notifications
You must be signed in to change notification settings - Fork 258
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
Add pex --docs
and several pex3 docs
options.
#2365
Conversation
The `pex --docs` shortcut should provide an ergonomic way to open the local docs for most Pex CLI users (undoubtedly few use `pex3`). The `pex3 docs` additional options allow for most of the control needed though, and the help for the `pex --docs` option points there.
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 am not sure on the whole server/pidfile logic but everything lgtm.
Thanks for taking a look @zmanji.
That is just moved code in this PR (so |
STANDARD_PORT = 45585 | ||
|
||
|
||
def serve_html_docs( |
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.
This function was pretty much a pure extraction from the run method of pex.cli.commands.docs.Docs
so that pex --docs
could share the infra.
|
||
|
||
@attr.s(frozen=True) | ||
class Pidfile(object): |
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.
This file was pretty much a pure extraction from pex.cli.commands.docs
so that pex --docs
could share the infra.
This needs to be extracted out to the doc site, but best to get it clear here now.
The
pex --docs
shortcut should provide an ergonomic way to open thelocal docs for most Pex CLI users (undoubtedly few use
pex3
). Thepex3 docs
additional options allow for most of the control neededthough, and the help for the
pex --docs
option points there.