AVRO-3867: [Python][Build] Fix the broken link to the Python API doc in the web site #2509
Conversation
| dist) dist;; | ||
| dist) | ||
| dist | ||
| doc |
There was a problem hiding this comment.
It looks to me that the Python SDK distribution does not include its documentation. Is this normal in the Python world ?
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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.
AVRO-3867
What is the purpose of the change
This PR fixes an issue that the link to the Python API doc in the web site is broken.
I built the website by
./build.shdist and then tried to access to the Python API doc but the link seems broken.The cause is
py/build.sh distdoesn't generate the document.So this PR includes a fix to generate the document when we run
py/build.sh dist.Verifying this change
Built the web site and confirmed the link is available.
Documentation