You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@spark.apache.org by "Noel Smith (JIRA)" <ji...@apache.org> on 2015/09/02 16:28:46 UTC
[jira] [Comment Edited] (SPARK-10415) Enhance Navigation Sidebar in
PySpark API
[ https://issues.apache.org/jira/browse/SPARK-10415?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14727001#comment-14727001 ]
Noel Smith edited comment on SPARK-10415 at 9/2/15 2:28 PM:
------------------------------------------------------------
It's designed to work correctly with the Sphinx-generated API docs.
It's basically some JavaScript + CSS that gets added into the API pages. When the page renders it injects links to classes/functions found on on the current page into the table of contents in the sidebar. Ideally I was hoping Sphinx would allow you to configure the table of contents to include classes/functions - but there doesn't seem to be a simple way of doing this (even with plugins). Using JavaScript seemed like a reasonable (and relatively unobtrusive) compromise.
The experimental tags are extracted from the existing "Experimental" notes in the Python docstrings. I've added pull request with the details.
was (Author: noelsmith):
Simple CSS/JavaScript additions to the theme that transform the page on rendering. I couldn't find a simple way of doing this within Sphinx (or via a Sphinx plugin).
The experimental tags are extracted from the existing "Experimental" notes in the Python doc strings. I'll add pull request in a sec with the details.
> Enhance Navigation Sidebar in PySpark API
> -----------------------------------------
>
> Key: SPARK-10415
> URL: https://issues.apache.org/jira/browse/SPARK-10415
> Project: Spark
> Issue Type: Improvement
> Components: Documentation, PySpark
> Reporter: Noel Smith
> Priority: Minor
>
> To make it easier to browse packages in the PySpark API documentation it would be useful to expand the navigation sidebar to include more details:
> * Classes
> * Functions
> * Tags to highlight experimental features
> Currently the sidebar only displays modules / submodules which makes it hard to get a feel for the overall structure + functionality of the PySpark API. Adding the extra entries makes it simpler to understand what each module does and also makes navigation to individual classes / functions easier.
> Online example here (suggestions / thoughts welcome!): https://dl.dropboxusercontent.com/u/20821334/pyspark-api-nav-enhance/pyspark.mllib.html
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@spark.apache.org
For additional commands, e-mail: issues-help@spark.apache.org