You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by GitBox <gi...@apache.org> on 2022/11/11 12:22:53 UTC
[GitHub] [pulsar-site] tisonkun opened a new pull request, #283: Document how to generate apidoc python
tisonkun opened a new pull request, #283:
URL: https://github.com/apache/pulsar-site/pull/283
This closes https://github.com/apache/pulsar/issues/18347.
cc @michaeljmarshall please take a look.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar-site] tisonkun merged pull request #283: Document how to generate apidoc python
Posted by GitBox <gi...@apache.org>.
tisonkun merged PR #283:
URL: https://github.com/apache/pulsar-site/pull/283
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar-site] tisonkun commented on a diff in pull request #283: Document how to generate apidoc python
Posted by GitBox <gi...@apache.org>.
tisonkun commented on code in PR #283:
URL: https://github.com/apache/pulsar-site/pull/283#discussion_r1020173248
##########
site2/tools/apidoc/python/pydoctor-generator-helper.sh:
##########
@@ -0,0 +1,38 @@
+#!/usr/bin/env bash
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+
+
+set -x -e
+
+if [ -z "$PULSAR_VERSION" ]; then
+ echo "PULSAR_VERSION must be set."
+ exit 1
+fi
+
+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
Review 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.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar-site] tisonkun commented on a diff in pull request #283: Document how to generate apidoc python
Posted by GitBox <gi...@apache.org>.
tisonkun commented on code in PR #283:
URL: https://github.com/apache/pulsar-site/pull/283#discussion_r1020174550
##########
site2/tools/apidoc/python/pydoctor-generator.sh:
##########
@@ -0,0 +1,45 @@
+#!/usr/bin/env bash
Review 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 :)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar-site] tisonkun commented on a diff in pull request #283: Document how to generate apidoc python
Posted by GitBox <gi...@apache.org>.
tisonkun commented on code in PR #283:
URL: https://github.com/apache/pulsar-site/pull/283#discussion_r1020173611
##########
site2/tools/apidoc/python/pydoctor-generator-helper.sh:
##########
@@ -0,0 +1,38 @@
+#!/usr/bin/env bash
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+
+
+set -x -e
+
+if [ -z "$PULSAR_VERSION" ]; then
+ echo "PULSAR_VERSION must be set."
+ exit 1
+fi
+
+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
Review Comment:
Verified the overall script by hardcoding the tag as `main` locally.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar-site] tisonkun commented on pull request #283: Document how to generate apidoc python
Posted by GitBox <gi...@apache.org>.
tisonkun commented on PR #283:
URL: https://github.com/apache/pulsar-site/pull/283#issuecomment-1312947909
Merging...
If later we have different release process for Python client, we can update it correspondingly.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org