This is an automated email from the ASF dual-hosted git repository.
dongjoon pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/spark.git
The following commit(s) were added to refs/heads/master by this push:
new b6d6cf30efb [SPARK-46045][DOCS][PS] Add individual categories for
`Options and settings` to API reference
b6d6cf30efb is described below
commit b6d6cf30efb2ca4427b93d289b11c4eb98125d81
Author: Haejoon Lee <haejoon....@databricks.com>
AuthorDate: Tue Nov 21 21:39:49 2023 -0800
[SPARK-46045][DOCS][PS] Add individual categories for `Options and
settings` to API reference
### What changes were proposed in this pull request?
This PR proposes to add individual categories for `Options and settings` to
API reference such as pandas does:
<img width="1121" alt="Screenshot 2023-11-22 at 11 12 55 AM"
src="https://github.com/apache/spark/assets/44108233/e792f54e-09e5-4a0c-a5e5-f358eb043420";>
### Why are the changes needed?
Users can more easily access options and settings related content.
Previously, it was hidden under the general functions category, making it less
accessible.
### Does this PR introduce _any_ user-facing change?
No API change, only the API reference page will be updated as below.
<img width="1083" alt="Screenshot 2023-11-22 at 11 14 58 AM"
src="https://github.com/apache/spark/assets/44108233/46dbe00e-a652-4a6d-bd4c-b031533ed7ac";>
### How was this patch tested?
Manually build docs on local as described above.
### Was this patch authored or co-authored using generative AI tooling?
No.
Closes #43948 from itholic/options_and_settings_doc.
Authored-by: Haejoon Lee <haejoon....@databricks.com>
Signed-off-by: Dongjoon Hyun <dh...@apple.com>
---
.../reference/pyspark.pandas/general_functions.rst | 11 ------
.../docs/source/reference/pyspark.pandas/index.rst | 1 +
.../pyspark.pandas/{index.rst => options.rst} | 42 ++++++++++------------
.../source/user_guide/pandas_on_spark/options.rst | 2 ++
4 files changed, 22 insertions(+), 34 deletions(-)
diff --git a/python/docs/source/reference/pyspark.pandas/general_functions.rst
b/python/docs/source/reference/pyspark.pandas/general_functions.rst
index a67c0a872e0..9de322b2968 100644
--- a/python/docs/source/reference/pyspark.pandas/general_functions.rst
+++ b/python/docs/source/reference/pyspark.pandas/general_functions.rst
@@ -23,17 +23,6 @@ General functions
=================
.. currentmodule:: pyspark.pandas
-Working with options
---------------------
-
-.. autosummary::
- :toctree: api/
-
- reset_option
- get_option
- set_option
- option_context
-
Data manipulations and SQL
--------------------------
.. autosummary::
diff --git a/python/docs/source/reference/pyspark.pandas/index.rst
b/python/docs/source/reference/pyspark.pandas/index.rst
index 0d45ba64b4d..6021be707e5 100644
--- a/python/docs/source/reference/pyspark.pandas/index.rst
+++ b/python/docs/source/reference/pyspark.pandas/index.rst
@@ -36,6 +36,7 @@ This page gives an overview of all public pandas API on Spark.
window
groupby
resampling
+ options
ml
extensions
testing
diff --git a/python/docs/source/reference/pyspark.pandas/index.rst
b/python/docs/source/reference/pyspark.pandas/options.rst
similarity index 69%
copy from python/docs/source/reference/pyspark.pandas/index.rst
copy to python/docs/source/reference/pyspark.pandas/options.rst
index 0d45ba64b4d..de4c19680ab 100644
--- a/python/docs/source/reference/pyspark.pandas/index.rst
+++ b/python/docs/source/reference/pyspark.pandas/options.rst
@@ -16,26 +16,22 @@
under the License.
-===================
-Pandas API on Spark
-===================
-
-This page gives an overview of all public pandas API on Spark.
-
-.. note::
- pandas API on Spark follows the API specifications of latest pandas release.
-
-.. toctree::
- :maxdepth: 2
-
- io
- general_functions
- series
- frame
- indexing
- window
- groupby
- resampling
- ml
- extensions
- testing
+.. _api.options:
+
+====================
+Options and settings
+====================
+.. currentmodule:: pyspark.pandas
+
+API for configuring global behavior. See :ref:`the User Guide
<user_guide.options>` for more.
+
+Working with options
+--------------------
+
+.. autosummary::
+ :toctree: api/
+
+ reset_option
+ get_option
+ set_option
+ option_context
diff --git a/python/docs/source/user_guide/pandas_on_spark/options.rst
b/python/docs/source/user_guide/pandas_on_spark/options.rst
index 774a0e23f87..82b1a921460 100644
--- a/python/docs/source/user_guide/pandas_on_spark/options.rst
+++ b/python/docs/source/user_guide/pandas_on_spark/options.rst
@@ -16,6 +16,8 @@
under the License.
+.. _user_guide.options:
+
====================
Options and settings
====================
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscr...@spark.apache.org
For additional commands, e-mail: commits-h...@spark.apache.org
