You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@sedona.apache.org by "zhangfengcdt (via GitHub)" <gi...@apache.org> on 2025/07/30 04:00:55 UTC

[PR] [CI] Add Python API Documentation to CI/CD Pipeline [sedona]

zhangfengcdt opened a new pull request, #2195:
URL: https://github.com/apache/sedona/pull/2195

   ## Did you read the Contributor Guide?
   
   - Yes, I have read the [Contributor Rules](https://sedona.apache.org/latest/community/rule/) and [Contributor Development Guide](https://sedona.apache.org/latest/community/develop/)
   
   ## Is this PR related to a ticket?
   
   - No:
     - this is a CI update. The PR name follows the format `[CI] my subject`
   
   ## What changes were proposed in this PR?
    This PR enhances the documentation build process by adding automated Python API documentation
     generation using Sphinx, following the same pattern as existing R documentation generation.
   
   ## How was this patch tested?
   CI Build
   
   ## Did this PR include necessary documentation updates?
   
   - No, this PR does not affect any public API so no need to change the documentation.
   


-- 
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@sedona.apache.org

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

Re: [PR] [CI] Add Python API Documentation to CI/CD Pipeline [sedona]

Posted by "zhangfengcdt (via GitHub)" <gi...@apache.org>.
zhangfengcdt commented on PR #2195:
URL: https://github.com/apache/sedona/pull/2195#issuecomment-3136608421

   > @zhangfengcdt The Python docs do not have actual text in individual function. Is this expected? https://sedona.apache.org/latest-snapshot/api/pydocs/index.html
   
   It is not desired. It looks like it might be caused by the python build env on ci (with sphinx) does not install all required packages it needs to generate the doc html. Locally, when I have all rthe equired packages, it generates correctly. I will debug and see how to fix it on ci. It should look something like this:
   
   
   
   
   
   <img width="1098" height="814" alt="Screenshot 2025-07-30 at 7 27 18 AM" src="https://github.com/user-attachments/assets/53efe374-104f-4ffc-91d6-113a4a6f8524" />
   
   
   
   
   


-- 
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@sedona.apache.org

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

Re: [PR] [CI] Add Python API Documentation to CI/CD Pipeline [sedona]

Posted by "jiayuasu (via GitHub)" <gi...@apache.org>.
jiayuasu merged PR #2195:
URL: https://github.com/apache/sedona/pull/2195


-- 
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@sedona.apache.org

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

Re: [PR] [CI] Add Python API Documentation to CI/CD Pipeline [sedona]

Posted by "jiayuasu (via GitHub)" <gi...@apache.org>.
jiayuasu commented on PR #2195:
URL: https://github.com/apache/sedona/pull/2195#issuecomment-3134962234

   @zhangfengcdt The Python docs do not have actual text in individual function. Is this expected? https://sedona.apache.org/latest-snapshot/api/pydocs/index.html


-- 
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@sedona.apache.org

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