This is an automated email from the ASF dual-hosted git repository.
tison pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/pulsar-site.git
The following commit(s) were added to refs/heads/main by this push:
new bbc2c130928 chore: remove unnecessary release stuff (#590)
bbc2c130928 is described below
commit bbc2c1309280a92d96394795ef67c389b8be8cdc
Author: tison <[email protected]>
AuthorDate: Sun May 28 20:28:38 2023 +0800
chore: remove unnecessary release stuff (#590)
Signed-off-by: tison <[email protected]>
---
contribute/release-process.md | 42 ----------------------
tools/pytools/README.md | 13 -------
tools/pytools/bin/py-apidoc-generator.py | 43 ----------------------
tools/pytools/lib/execute/pdoc_generator.py | 41 ---------------------
tools/pytools/lib/execute/pydoctor_generator.py | 48 -------------------------
tools/pytools/scripts/pdoc-generator-helper | 33 -----------------
tools/pytools/tmp/.gitignore | 1 -
7 files changed, 221 deletions(-)
diff --git a/contribute/release-process.md b/contribute/release-process.md
index c66e197e446..8d866a4e621 100644
--- a/contribute/release-process.md
+++ b/contribute/release-process.md
@@ -471,48 +471,6 @@ Once the docs are generated, you can add them and submit
them in a PR. The expec
Read more on the manual of
[pytools](https://github.com/apache/pulsar-site/tree/main/tools/pytools/README.md).
-### C++ client docs
-
-:::caution
-
-This step is for feature releases only, unless you're sure that significant
doc fixes are made against the patch release.
-
-:::
-
-After publishing the C++ client, run the following script from the main branch
of apache/pulsar-site repo:
-
-```shell
-cd tools/pytools
-poetry install
-poetry run bin/cpp-apidoc-generator.py 2.X.0
-```
-
-Once the docs are generated, you can add them and submit them in a PR. The
expected doc output is `static/api/cpp`.
-
-Read more on the manual of
[pytools](https://github.com/apache/pulsar-site/tree/main/tools/pytools/README.md).
-
-### Python client docs
-
-:::caution
-
-This step is for feature releases only, unless you're sure that significant
doc fixes are made against the patch release.
-
-:::
-
-After publishing the Python client, run the following script from the main
branch of apache/pulsar-site repo:
-
-```shell
-cd tools/pytools
-poetry install
-poetry run bin/py-apidoc-generator.py 2.X.0
-```
-
-Note that before version 3.0.0, it builds the docs within a docker image, so
you'll need to have docker running.
-
-Once the docs are generated, you can add them and submit them in a PR. The
expected doc output is `static/api/python`.
-
-Read more on the manual of
[pytools](https://github.com/apache/pulsar-site/tree/main/tools/pytools/README.md).
-
## Update the site
Clone the apache/site repo:
diff --git a/tools/pytools/README.md b/tools/pytools/README.md
index 695a33dd01d..480d1b0356e 100644
--- a/tools/pytools/README.md
+++ b/tools/pytools/README.md
@@ -69,19 +69,6 @@ poetry run bin/js-apidoc-generator.py <VERSION>
... where the `VERSION` is released semantic version like `1.8.2`.
-### [py-apidoc-generator](bin/py-apidoc-generator.py)
-
-This executable generates API docs for Pulsar Python Client:
-
-```bash
-poetry run bin/py-apidoc-generator.py <VERSION>
-```
-
-... where the `VERSION` is released semantic version like `2.10.2` or `3.0.0`.
-
-* Releases start from 3.0.0 uses
[`pydoctor`](https://github.com/twisted/pydoctor) to generate API docs.
-* Releases before 3.0.0 uses [`pdoc`](https://github.com/mitmproxy/pdoc) to
generate API docs.
-
### [java-apidoc-generator](bin/java-apidoc-generator.py)
This executable generates API docs for Pulsar Java Client, Admin and Functions
using Maven:
diff --git a/tools/pytools/bin/py-apidoc-generator.py
b/tools/pytools/bin/py-apidoc-generator.py
deleted file mode 100755
index 00434a261ab..00000000000
--- a/tools/pytools/bin/py-apidoc-generator.py
+++ /dev/null
@@ -1,43 +0,0 @@
-#!/usr/bin/env python3
-
-# 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.
-
-from argparse import ArgumentParser, ArgumentDefaultsHelpFormatter
-
-import semver
-from execute import pydoctor_generator, pdoc_generator
-
-
-def _dispatch(version: str):
- ver = semver.VersionInfo.parse(version)
- if ver.compare('3.0.0') < 0:
- pdoc_generator.execute(version)
- else:
- pydoctor_generator.execute(version)
-
-
-if __name__ == '__main__':
- parser = ArgumentParser(formatter_class=ArgumentDefaultsHelpFormatter)
- parser.set_defaults(func=_dispatch)
- parser.add_argument('version', metavar='VERSION', help='version of Pulsar
C++ Client')
-
- args = parser.parse_args()
- fn = args.func
- args = dict(vars(args))
- del args['func']
- fn(**args)
diff --git a/tools/pytools/lib/execute/pdoc_generator.py
b/tools/pytools/lib/execute/pdoc_generator.py
deleted file mode 100644
index 7136d345cd8..00000000000
--- a/tools/pytools/lib/execute/pdoc_generator.py
+++ /dev/null
@@ -1,41 +0,0 @@
-# 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.
-
-import docker
-import semver
-
-from constant import pytools_path, site_path
-
-IMAGE = 'apachepulsar/pulsar-build:manylinux-cp38-cp38'
-
-
-def execute(version: str):
- ver = semver.VersionInfo.parse(version)
- assert ver.compare('3.0.0') < 0
-
- v = f"{ver.major}.{ver.minor}.{ver.patch}"
- client = docker.from_env()
- client.containers.run(
- IMAGE,
- command='/scripts/pdoc-generator-helper',
- remove=True,
- environment=[f'PULSAR_VERSION={v}'],
- volumes=[
- f'{pytools_path()}/scripts:/scripts',
- f'{site_path()}/static/api:/api',
- ]
- )
diff --git a/tools/pytools/lib/execute/pydoctor_generator.py
b/tools/pytools/lib/execute/pydoctor_generator.py
deleted file mode 100644
index 90b73269b44..00000000000
--- a/tools/pytools/lib/execute/pydoctor_generator.py
+++ /dev/null
@@ -1,48 +0,0 @@
-# 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.
-
-import tempfile
-from pathlib import Path
-
-import semver
-from command import find_command, run
-from constant import site_path, pytools_path
-
-
-def execute(version: str):
- git = find_command('git', msg="git is required")
- poetry = find_command('poetry', msg="poetry is required")
-
- ver = semver.VersionInfo.parse(version)
- assert ver.compare('3.0.0') >= 0
-
- tmpdir = (Path(pytools_path()) / 'tmp').absolute()
- with tempfile.TemporaryDirectory(dir=tmpdir) as cwd:
- v = f"{ver.major}.{ver.minor}.x"
- tag = f"v{ver.major}.{ver.minor}.{ver.patch}"
- remote = 'https://github.com/apache/pulsar-client-python'
- run(git, 'clone', '--depth=1', '--single-branch', f'--branch={tag}',
remote, cwd=cwd)
- options = [
- 'run', 'pydoctor',
- '--make-html',
-
f'--html-viewsource-base=https://github.com/apache/pulsar-client-python/tree/{tag}',
- '--docformat=numpy', '--theme=readthedocs',
- '--intersphinx=https://docs.python.org/3/objects.inv',
- f'--html-output={site_path()}/static/api/python/{v}',
- f'{cwd}/pulsar-client-python/pulsar'
- ]
- run(poetry, *options)
diff --git a/tools/pytools/scripts/pdoc-generator-helper
b/tools/pytools/scripts/pdoc-generator-helper
deleted file mode 100755
index 1aa963cbc08..00000000000
--- a/tools/pytools/scripts/pdoc-generator-helper
+++ /dev/null
@@ -1,33 +0,0 @@
-#!/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
-
-DOC_VERSION=$(echo "$PULSAR_VERSION" | awk -F \. '{print $1"."$2".x"}')
-
-python -m pip install --upgrade pip
-
-pip install -U pdoc
-pip install pulsar-client=="${PULSAR_VERSION}"
-pdoc pulsar -o /api/python/"${DOC_VERSION}"
diff --git a/tools/pytools/tmp/.gitignore b/tools/pytools/tmp/.gitignore
deleted file mode 100644
index 72e8ffc0db8..00000000000
--- a/tools/pytools/tmp/.gitignore
+++ /dev/null
@@ -1 +0,0 @@
-*
