-
Notifications
You must be signed in to change notification settings - Fork 170
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
Document how to generate apidoc python #283
Conversation
Signed-off-by: tison <[email protected]>
python -m pip install --upgrade pip | ||
|
||
pip install -U pydoctor | ||
git clone https://github.com/apache/pulsar-client-python --single-branch --branch v$PULSAR_VERSION |
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.
cc @merlimat @BewareMyPower @RobertIndie this line depends on that for each Python client release, we create a vX.Y.Z
tag. I notice that C++ client does it so make this assumption.
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.
Verified the overall script by hardcoding the tag as main
locally.
@@ -0,0 +1,45 @@ | |||
#!/usr/bin/env bash |
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 know that these two script files duplicate each other. But since scripts are less combinable, and this is a specific small scope, I'd like to keep it simple stupid :)
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.
Thanks for updating this @tisonkun!
Merging... If later we have different release process for Python client, we can update it correspondingly. |
This closes apache/pulsar#18347.
cc @michaeljmarshall please take a look.