Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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> \
Comment thread
BewareMyPower marked this conversation as resolved.
--docformat=numpy --theme=readthedocs \
--intersphinx=https://docs.python.org/3/objects.inv \
--html-output=<path-to-apidocs> \
pulsar
```
Loading