spark-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Sean Owen (JIRA)" <>
Subject [jira] [Commented] (SPARK-19551) Theme for PySpark documenation could do with improving
Date Fri, 17 Feb 2017 09:02:41 GMT


Sean Owen commented on SPARK-19551:

Ping [~arthur-tacca]  If this is a doc build config change, that's easy, but, what's the change?
If you mean someone should write a whole framework for doc themes, no I don't think that's
in scope for Spark.

> Theme for PySpark documenation could do with improving
> ------------------------------------------------------
>                 Key: SPARK-19551
>                 URL:
>             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|]. 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

To unsubscribe, e-mail:
For additional commands, e-mail:

View raw message