BewareMyPower commented on code in PR #28: URL: https://github.com/apache/pulsar-client-python/pull/28#discussion_r1014774093
########## README.md: ########## @@ -110,3 +110,17 @@ Run a single unit test (e.g. `PulsarTest.test_tls_auth`): ```bash python3 ./tests/pulsar_test.py 'PulsarTest.test_tls_auth' ``` + +## Generate API docs + +Pulsar Python Client uses [pydoctor](https://github.com/twisted/pydoctor) to generate API docs. To generate by yourself, run the following command in the root path of this repository: + +```bash +pip3 install pydoctor +pydoctor --make-html \ + --html-viewsource-base=https://github.com/apache/pulsar-client-python/tree/<release-version-tag> \ Review Comment: Thanks for your explanation. But I see the source links to an unexpected URL. For example, the `class Client: (source)` links to https://github.com/apache/pulsar-client-python/blob/main/pulsar/__init__.py#L344 ```python _check_type(str, auth_params_string, 'auth_params_string') ``` Do you know the reason? Or does it link correctly in your env? -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
