Skip to content

Improve apidoc with pydoctor tool #28

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 12 commits into from
Nov 6, 2022
Merged

Improve apidoc with pydoctor tool #28

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
6ba9969
Improve apidoc with pydoctor tool
tisonkun Nov 4, 2022
3fd9691
more args to parameters
tisonkun Nov 4, 2022
59bd48a
fix syntax
tisonkun Nov 4, 2022
3e4b25d
more args to parameters
tisonkun Nov 4, 2022
281d7fe
more args to parameters
tisonkun Nov 4, 2022
cd41a13
more args to parameters
tisonkun Nov 4, 2022
776be9d
format function docstrings
tisonkun Nov 4, 2022
5152dcb
more attributes
tisonkun Nov 4, 2022
4d6a795
fix format
tisonkun Nov 5, 2022
29d3df4
more args to parameters
tisonkun Nov 5, 2022
17439a7
fix links
tisonkun Nov 5, 2022
2648d5f
update README.md
tisonkun Nov 5, 2022
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
View file
Open in desktop
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> \
--docformat=numpy --theme=readthedocs \
--intersphinx=https://docs.python.org/3/objects.inv \
--html-output=<path-to-apidocs> \
pulsar
```
Loading