Martijn Visser created FLINK-41024:
--------------------------------------

             Summary: Upgrade PyFlink docs to Sphinx 9.1
                 Key: FLINK-41024
                 URL: https://issues.apache.org/jira/browse/FLINK-41024
             Project: Flink
          Issue Type: Technical Debt
          Components: API / Python, Documentation
            Reporter: Martijn Visser


Built on Python 3.14, Sphinx 7.4 drops the return type of DataFrame.take_batch 
and shows ForwardRef(...) in other signatures. CI builds the docs on Python 
3.13, so this shows once CI moves to 3.14. Sphinx 9.1 renders them correctly, 
but 9.1.0 breaks the search in the Chinese docs 
(https://github.com/sphinx-doc/sphinx/issues/14229, fixed for 9.1.1).

We should upgrade to Sphinx 9.1.1 and pydata-sphinx-theme 0.23 once 9.1.1 is 
out. Sphinx 9.1 needs Python 3.12, so requires-python of flink-python/docs goes 
to 3.12. PyFlink itself keeps supporting 3.9.



--
This message was sent by Atlassian Jira
(v8.20.10#820010)

Reply via email to