Include the C extension when generating API docs #126
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
### Motivation apache#85 (comment) Some targets in the API docs are referenced from the `_pulsar` module, while the `pydoctor` command does not generate API docs for it. It's not friendly to users, e.g. they cannot find which values could `_pulsar.ConsumerType` be. ``` pulsar/__init__.py:695: Cannot find link target for "_pulsar.ConsumerType" ``` ### Modifications Fix the documents to describe how to include the API docs for the `_pulsar` module when generating API docs. It also fixes some other warnings when running the `pydoctor` command.
tisonkun
approved these changes
May 25, 2023
merlimat
approved these changes
May 26, 2023
BewareMyPower
added a commit
to BewareMyPower/pulsar-client-python
that referenced
this pull request
Jun 5, 2023
…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.
BewareMyPower
added a commit
that referenced
this pull request
Jun 12, 2023
…cess (#131) ### Motivation #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.
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
#85 (comment)
Some targets in the API docs are referenced from the
_pulsarmodule, while thepydoctorcommand does not generate API docs for it. It's not friendly to users, e.g. they cannot find which values could_pulsar.ConsumerTypebe.Modifications
Fix the documents to describe how to include the API docs for the
_pulsarmodule when generating API docs. It also fixes some other warnings when running thepydoctorcommand.