Skip to content
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

AVRO-3867: [Python][Build] Fix the broken link to the Python API doc in the web site #2509

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

AVRO-3867: [Python][Build] Fix the broken link to the Python API doc in the web site #2509

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 4 additions & 1 deletion lang/py/build.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,10 @@ main() {
for target; do
case "$target" in
clean) clean;;
dist) dist;;
dist)
dist
doc
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks to me that the Python SDK distribution does not include its documentation. Is this normal in the Python world ?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know if it's normal or not but the web site seems to be intended to include the doc.
https://github.com/apache/avro/blob/master/doc/content/en/docs/%2B%2Bversion%2B%2B/api-py.md?plain=1

Also, I can't find the doc accessible from the PyPi.
https://pypi.org/project/avro/

cc: @kojiromike

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The Python implementation never published api docs before. I added the sphinx build basics, and modeled it after other implementation docs builds. I know it builds locally, but I don't know if it really works in the expected way yet.

As for what's common in Python, most open source Python projects IME publish their docs to readthedocs/rtfd.io. But I'd consider it a step in the right direction if this implementation published its api docs at all.

;;
doc) doc;;
interop-data-generate) interop-data-generate;;
interop-data-test) interop-data-test;;
Expand Down