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/05 16:30:17 UTC

[PR] [DOC] Add Sphinx Doc Build Framework to Sedona Python [sedona]

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

   ## 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 documentation update. The PR name follows the format `[DOCS] my subject`
   
   ## What changes were proposed in this PR?
   This PR add python document framework based on Sphinx packages.
   
   ## How was this patch tested?
   NA
   
   ## Did this PR include necessary documentation updates?
   
   - Yes, I have updated 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] [DOC] Add Sphinx Doc Build Framework to Sedona Python [sedona]

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

   Great work, Feng. I will merge this first and make some modification on it!


-- 
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] [DOC] Add Sphinx Doc Build Framework to Sedona Python [sedona]

Posted by "Copilot (via GitHub)" <gi...@apache.org>.
Copilot commented on code in PR #2064:
URL: https://github.com/apache/sedona/pull/2064#discussion_r2189028728


##########
python/.gitignore:
##########
@@ -24,3 +24,4 @@
 /dist/
 /sedona/utils/*.so
 __pycache__
+/sedona/doc/_build/

Review Comment:
   The ignore rule targets `/sedona/doc/_build/` but the actual build output path is `python/sedona/doc/_build/`. You should update this entry to `sedona/doc/_build/` or `python/sedona/doc/_build/` so that the Sphinx build output is properly ignored.
   ```suggestion
   /python/sedona/doc/_build/
   ```



-- 
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] [DOC] Add Sphinx Doc Build Framework to Sedona Python [sedona]

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


-- 
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] [DOC] Add Sphinx Doc Build Framework to Sedona Python [sedona]

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

   screenshot of the generated doc:
   
   <img width="1090" alt="Screenshot 2025-07-05 at 9 16 48 AM" src="https://github.com/user-attachments/assets/a1bcb440-86a3-4e86-84b4-6a7061f365f0" />
   
   


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