You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@avro.apache.org by "sarutak (via GitHub)" <gi...@apache.org> on 2023/09/20 20:59:36 UTC

[GitHub] [avro] sarutak opened a new pull request, #2509: AVRO-3867: [Python][Build] Fix the broken link to the Python API doc in the web site

sarutak opened a new pull request, #2509:
URL: https://github.com/apache/avro/pull/2509

   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.sh` dist and then tried to access to the Python API doc but the link seems broken.
   
   The cause is `py/build.sh dist` doesn'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
   
   - Does this pull request introduce a new feature? (no)
   


-- 
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: dev-unsubscribe@avro.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [avro] martin-g commented on a diff in pull request #2509: AVRO-3867: [Python][Build] Fix the broken link to the Python API doc in the web site

Posted by "martin-g (via GitHub)" <gi...@apache.org>.
martin-g commented on code in PR #2509:
URL: https://github.com/apache/avro/pull/2509#discussion_r1332543088


##########
lang/py/build.sh:
##########
@@ -84,7 +84,10 @@ main() {
   for target; do
     case "$target" in
       clean) clean;;
-      dist) dist;;
+      dist)
+        dist
+        doc

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



-- 
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: issues-unsubscribe@avro.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

Re: [PR] AVRO-3867: [Python][Build] Fix the broken link to the Python API doc in the web site [avro]

Posted by "kojiromike (via GitHub)" <gi...@apache.org>.
kojiromike commented on code in PR #2509:
URL: https://github.com/apache/avro/pull/2509#discussion_r1353855528


##########
lang/py/build.sh:
##########
@@ -84,7 +84,10 @@ main() {
   for target; do
     case "$target" in
       clean) clean;;
-      dist) dist;;
+      dist)
+        dist
+        doc

Review 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.



-- 
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: issues-unsubscribe@avro.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [avro] sarutak commented on a diff in pull request #2509: AVRO-3867: [Python][Build] Fix the broken link to the Python API doc in the web site

Posted by "sarutak (via GitHub)" <gi...@apache.org>.
sarutak commented on code in PR #2509:
URL: https://github.com/apache/avro/pull/2509#discussion_r1332583842


##########
lang/py/build.sh:
##########
@@ -84,7 +84,10 @@ main() {
   for target; do
     case "$target" in
       clean) clean;;
-      dist) dist;;
+      dist)
+        dist
+        doc

Review 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 



-- 
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: issues-unsubscribe@avro.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org