tisonkun commented on code in PR #28: URL: https://github.com/apache/pulsar-client-python/pull/28#discussion_r1014760162
########## 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: This option is to show: <img width="1727" alt="image" src="https://user-images.githubusercontent.com/18818196/200151515-d2ef7607-26fe-463d-8393-5b35757fbb60.png";> ... for building the latest docs, you can use `/tree/main` or other refs. This should be inituitive. ########## 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: This option is to show: <img width="1727" alt="image" src="https://user-images.githubusercontent.com/18818196/200151515-d2ef7607-26fe-463d-8393-5b35757fbb60.png";> ... for building the latest docs, you can use `/tree/main` or other refs. This should be intuitive. -- 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]
![https://user-images.githubusercontent.com/18818196/200151515-d2ef7607-26fe-463d-8393-5b35757fbb60.png"](https://user-images.githubusercontent.com/18818196/200151515-d2ef7607-26fe-463d-8393-5b35757fbb60.png"){kind=link}