Arthur Tacca created SPARK-19551:
------------------------------------

             Summary: Theme for PySpark documenation could do with improving
                 Key: SPARK-19551
                 URL: https://issues.apache.org/jira/browse/SPARK-19551
             Project: Spark
          Issue Type: Documentation
          Components: Documentation, PySpark
    Affects Versions: 2.1.0
            Reporter: Arthur Tacca
            Priority: Minor


I have found the Python Spark documentation hard to navigate for two reasons:

* Each page in the documentation is huge, because the whole of the 
documentation is split up into only a few chunks.
* The methods for each class is not listed in a short form, so the only way to 
look through them is to browse past the full documentation for all methods 
(including parameter lists, examples, etc.).

This has irritated someone enough that they have done [their own build of the 
pyspark documentation|http://takwatanabe.me/pyspark/index.html]. In comparison 
to the official docs they are a delight to use. But of course it is not clear 
whether they'll be kept up to date, which is why I'm asking here that the 
official docs are improved. Perhaps that site could be used as inspiration? I 
don't know much about these things, but it appears that the main change they 
have made is to switch to the "read the docs" theme.



--
This message was sent by Atlassian JIRA
(v6.3.15#6346)

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

Reply via email to