itholic commented on code in PR #44012:
URL: https://github.com/apache/spark/pull/44012#discussion_r1405232095


##########
python/docs/source/reference/pyspark.pandas/frame.rst:
##########
@@ -299,6 +299,7 @@ in Spark. These can be accessed by 
``DataFrame.spark.<function/property>``.
 
 .. autosummary::
    :toctree: api/
+   :template: autosummary/accessor_method.rst

Review Comment:
   For example, previously the rst file was created as follows:
   
   ```rst
   pyspark.sql.SparkSession.builder.appName
   ========================================
   
   .. currentmodule:: pyspark.sql.SparkSession
   
   .. automethod:: builder.appName
   ```
   However, in newer Sphinx versions it is generated like this:
   
   ```rst
   pyspark.sql.SparkSession.builder.appName
   ========================================
   
   .. currentmodule:: pyspark.sql
   
   .. automethod:: SparkSession.builder.appName
   ```
   
   In the case of functions used through internal classes or accessors like 
this, the package paths created in a new way will cause Sphinx build to fail. 
See https://github.com/sphinx-doc/sphinx/issues/7551 related issue.
   
   Therefore, I modified the path to be customized for these cases using a 
custom template such as Pandas does.



-- 
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: reviews-unsubscr...@spark.apache.org

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


---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscr...@spark.apache.org
For additional commands, e-mail: reviews-h...@spark.apache.org

Reply via email to