spark-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Hyukjin Kwon (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (SPARK-24530) Sphinx doesn't render autodoc_docstring_signature correctly (with Python 2?) and pyspark.ml docs are broken
Date Wed, 04 Jul 2018 02:23:00 GMT

    [ https://issues.apache.org/jira/browse/SPARK-24530?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16532159#comment-16532159
] 

Hyukjin Kwon commented on SPARK-24530:
--------------------------------------

There's workaround for this. To cut it short, Sphinx for Python 3 is required and installed
e.g., {{sudo pip3 install sphinx}} but Sphinx for Python 2 should be removed first before
installing Sphinx for Python 3 for sure if Sphinx for Python 2 is already installed.

Currently, whether it uses Sphinx for Pythom 3 or not can be manually checked by, {{cd python/docs
&& make clean html}}, checking if the keywords arguments are shown in the equaivelent
link above before making the release documentation for Python API.

> Sphinx doesn't render autodoc_docstring_signature correctly (with Python 2?) and pyspark.ml
docs are broken
> -----------------------------------------------------------------------------------------------------------
>
>                 Key: SPARK-24530
>                 URL: https://issues.apache.org/jira/browse/SPARK-24530
>             Project: Spark
>          Issue Type: Bug
>          Components: ML, PySpark
>    Affects Versions: 2.4.0
>            Reporter: Xiangrui Meng
>            Assignee: Hyukjin Kwon
>            Priority: Blocker
>         Attachments: Screen Shot 2018-06-12 at 8.23.18 AM.png, Screen Shot 2018-06-12
at 8.23.29 AM.png, image-2018-06-13-15-15-51-025.png, pyspark-ml-doc-utuntu18.04-python2.7-sphinx-1.7.5.png
>
>
> I generated python docs from master locally using `make html`. However, the generated
html doc doesn't render class docs correctly. I attached the screenshot from Spark 2.3 docs
and master docs generated on my local. Not sure if this is because my local setup.
> cc: [~dongjoon] Could you help verify?
>  
> The followings are our released doc status. Some recent docs seems to be broken.
> *2.1.x*
> (O) [https://spark.apache.org/docs/2.1.0/api/python/pyspark.ml.html#pyspark.ml.classification.LogisticRegression]
> (O) [https://spark.apache.org/docs/2.1.1/api/python/pyspark.ml.html#pyspark.ml.classification.LogisticRegression]
> (X) [https://spark.apache.org/docs/2.1.2/api/python/pyspark.ml.html#pyspark.ml.classification.LogisticRegression]
> *2.2.x*
> (O) [https://spark.apache.org/docs/2.2.0/api/python/pyspark.ml.html#pyspark.ml.classification.LogisticRegression]
> (X) [https://spark.apache.org/docs/2.2.1/api/python/pyspark.ml.html#pyspark.ml.classification.LogisticRegression]
> *2.3.x*
> (O) [https://spark.apache.org/docs/2.3.0/api/python/pyspark.ml.html#pyspark.ml.classification.LogisticRegression]
> (X) [https://spark.apache.org/docs/2.3.1/api/python/pyspark.ml.html#pyspark.ml.classification.LogisticRegression]



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)

---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@spark.apache.org
For additional commands, e-mail: issues-help@spark.apache.org


Mime
View raw message