[docs] Fix the incorrect API docs generation steps in the release process #131
Conversation
This file contains hidden or 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
…cess ### Motivation apache#126 adds the instruction to include the `_pulsar` C module when generating the API docs. However, it does not work when the library is installed from `pip`. It only works when the wheel is installed from `dist/*.whl` that is generated by the `python3 setup.py bdist_wheel` command in the README. The reason is the official Python wheel uses `auditwheel` to package all dynamic libraries, so the `_pulsar.so` depends on another dynamic library in the relative path. e.g. ```bash $ ldd ~/.local/lib/python3.8/site-packages/_pulsar.cpython-38-x86_64-linux-gnu.so libpulsar-b6dad138.so => /home/xyz/.local/lib/python3.8/site-packages/pulsar_client.libs/libpulsar-b6dad138.so (0x00007f8dc09b3000) ... ``` If we copy the `_pulsar.cpython-38-x86_64-linux-gnu.so` into the project directory, the `libpulsar-b6dad138.so` will not be found. ### Modifications In `RELEASE.md`, specify the path of `_pulsar.so` directly.
tisonkun
approved these changes
Jun 11, 2023
| 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 |
There was a problem hiding this comment.
I'd prefer to use a fork but it's fair enough to push origin.
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.
Motivation
#126 adds the instruction to include the
_pulsarC module when generating the API docs. However, it does not work when the library is installed frompip. It only works when the wheel is installed fromdist/*.whlthat is generated by thepython3 setup.py bdist_wheelcommand in the README.The reason is the official Python wheel uses
auditwheelto package all dynamic libraries, so the_pulsar.sodepends on another dynamic library in the relative path. e.g.If we copy the
_pulsar.cpython-38-x86_64-linux-gnu.sointo the project directory, thelibpulsar-b6dad138.sowill not be found.In addition, the path of the static API docs changed after the refactoring of
pulsar-site,Modifications
In
RELEASE.md, specify the path of_pulsar.sodirectly.