Document how to generate apidoc python #283
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
Signed-off-by: tison <[email protected]>
tisonkun
requested review from
BewareMyPower,
merlimat,
michaeljmarshall and
RobertIndie
tisonkun
commented
Nov 11, 2022
| 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.
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.
Verified the overall script by hardcoding the tag as main locally.
tisonkun
commented
Nov 11, 2022
| @@ -0,0 +1,45 @@ | |||
| #!/usr/bin/env bash | |||
There was a problem hiding this comment.
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 :)
michaeljmarshall
approved these changes
Nov 11, 2022
RobertIndie
approved these changes
Nov 14, 2022
|
Merging... If later we have different release process for Python client, we can update it correspondingly. |
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.
This closes apache/pulsar#18347.
cc @michaeljmarshall please take a look.