Skip to content

[docs] Fix the incorrect API docs generation steps in the release process #131

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Jun 12, 2023
Merged

[docs] Fix the incorrect API docs generation steps in the release process #131

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
34a5f9b
[docs] Fix the incorrect API docs generation steps in the release pro…
BewareMyPower Jun 5, 2023
fb7a425
Update the example PR
BewareMyPower Jun 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 18 additions & 10 deletions RELEASE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -219,29 +219,37 @@ Then, create a PR in [`pulsar-site`](https://github.com/apache/pulsar-site) repo
For minor releases, skip this section. For major releases, you should generate the HTML files into the [`pulsar-site`](https://github.com/apache/pulsar-site) repo:

```bash
# Use the first two version numbers, e.g. export VERSION=3.2
VERSION=X.Y

# You need to install the wheel to have the _pulsar.so installed
# It's better to run the following commands in an empty directory
python3 -m pip install pulsar-client==$VERSION.0 --force-reinstall
C_MODULE_PATH=$(python3 -c 'import _pulsar, os; print(_pulsar.__file__)')

git clone [email protected]:apache/pulsar-client-python.git
cd pulsar-client-python
git checkout vX.Y.0
# It's better to replace this URL with the URL of your own fork
git checkout v$VERSION.0
# You can skip this step if you already have the `pulsar-site` repository in your local env.
# In this case, you only need to modify the `--html-output` parameter in the following command.
git clone [email protected]:apache/pulsar-site.git
sudo python3 -m pip install pydoctor
cp $(python3 -c 'import _pulsar, os; print(_pulsar.__file__)') ./_pulsar.so
pydoctor --make-html \
--html-viewsource-base=https://github.com/apache/pulsar-client-python/tree/vX.Y.0 \
--html-viewsource-base=https://github.com/apache/pulsar-client-python/tree/v$VERSION.0 \
--docformat=numpy --theme=readthedocs \
--intersphinx=https://docs.python.org/3/objects.inv \
--html-output=./pulsar-site/site2/website-next/static/api/python/X.Y.x \
--html-output=./pulsar-site/static/api/python/$VERSION.x \
--introspect-c-modules \
./_pulsar.so \
$C_MODULE_PATH \
pulsar
cd pulsar-site
git checkout -b py-docs-X.Y
git checkout -b py-docs-$VERSION
git add .
git commit -m "Generate Python client X.Y.0 doc"
git push origin py-docs-X.Y
git commit -m "Generate Python client $VERSION.0 doc"
git push origin py-docs-$VERSION
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd prefer to use a fork but it's fair enough to push origin.

```

Then open a PR like: https://github.com/apache/pulsar-site/pull/342
Then open a PR like: https://github.com/apache/pulsar-site/pull/600

## Announce the release

Expand Down