apache / pulsar-client-python

Apache Pulsar Python client library
https://pulsar.apache.org/
Apache License 2.0
51 stars 39 forks source link

Include the C extension when generating API docs #126

Closed BewareMyPower closed 1 year ago

BewareMyPower commented 1 year ago

Motivation

https://github.com/apache/pulsar-client-python/issues/85#issuecomment-1531069608

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.