From e5231b5e69cffa02dc8aca2898181fbeca48139d Mon Sep 17 00:00:00 2001 From: Matthew Murray Date: Thu, 23 Jan 2025 16:20:31 -0800 Subject: [PATCH] [FEA] Make pylibcudf docs more visible --- docs/cudf/source/developer_guide/index.md | 1 - docs/cudf/source/developer_guide/library_design.md | 2 ++ docs/cudf/source/index.rst | 1 + .../pylibcudf => pylibcudf/api_docs}/aggregation.rst | 0 .../pylibcudf => pylibcudf/api_docs}/binaryop.rst | 0 .../api_docs/pylibcudf => pylibcudf/api_docs}/column.rst | 0 .../api_docs}/column_factories.rst | 0 .../pylibcudf => pylibcudf/api_docs}/concatenate.rst | 0 .../pylibcudf => pylibcudf/api_docs}/copying.rst | 0 .../pylibcudf => pylibcudf/api_docs}/datetime.rst | 0 .../pylibcudf => pylibcudf/api_docs}/expressions.rst | 0 .../pylibcudf => pylibcudf/api_docs}/filling.rst | 0 .../pylibcudf => pylibcudf/api_docs}/gpumemoryview.rst | 0 .../pylibcudf => pylibcudf/api_docs}/groupby.rst | 0 .../pylibcudf => pylibcudf/api_docs}/hashing.rst | 0 .../api_docs/pylibcudf => pylibcudf/api_docs}/index.rst | 6 +++--- .../pylibcudf => pylibcudf/api_docs}/interop.rst | 0 .../pylibcudf => pylibcudf/api_docs}/io/avro.rst | 0 .../api_docs/pylibcudf => pylibcudf/api_docs}/io/csv.rst | 0 .../pylibcudf => pylibcudf/api_docs}/io/index.rst | 0 .../pylibcudf => pylibcudf/api_docs}/io/json.rst | 0 .../pylibcudf => pylibcudf/api_docs}/io/parquet.rst | 0 .../api_docs}/io/parquet_metadata.rst | 0 .../pylibcudf => pylibcudf/api_docs}/io/text.rst | 0 .../pylibcudf => pylibcudf/api_docs}/io/timezone.rst | 0 .../api_docs/pylibcudf => pylibcudf/api_docs}/join.rst | 0 .../api_docs/pylibcudf => pylibcudf/api_docs}/json.rst | 0 .../pylibcudf => pylibcudf/api_docs}/labeling.rst | 0 .../api_docs/pylibcudf => pylibcudf/api_docs}/lists.rst | 0 .../api_docs/pylibcudf => pylibcudf/api_docs}/merge.rst | 0 .../pylibcudf => pylibcudf/api_docs}/null_mask.rst | 0 .../api_docs}/nvtext/byte_pair_encode.rst | 0 .../api_docs}/nvtext/edit_distance.rst | 0 .../api_docs}/nvtext/generate_ngrams.rst | 0 .../pylibcudf => pylibcudf/api_docs}/nvtext/index.rst | 0 .../pylibcudf => pylibcudf/api_docs}/nvtext/jaccard.rst | 0 .../pylibcudf => pylibcudf/api_docs}/nvtext/minhash.rst | 0 .../api_docs}/nvtext/ngrams_tokenize.rst | 0 .../api_docs}/nvtext/normalize.rst | 0 .../pylibcudf => pylibcudf/api_docs}/nvtext/replace.rst | 0 .../pylibcudf => pylibcudf/api_docs}/nvtext/stemmer.rst | 0 .../api_docs}/nvtext/subword_tokenize.rst | 0 .../pylibcudf => pylibcudf/api_docs}/nvtext/tokenize.rst | 0 .../pylibcudf => pylibcudf/api_docs}/partitioning.rst | 0 .../pylibcudf => pylibcudf/api_docs}/quantiles.rst | 0 .../api_docs/pylibcudf => pylibcudf/api_docs}/reduce.rst | 0 .../pylibcudf => pylibcudf/api_docs}/replace.rst | 0 .../pylibcudf => pylibcudf/api_docs}/reshape.rst | 0 .../pylibcudf => pylibcudf/api_docs}/rolling.rst | 0 .../api_docs/pylibcudf => pylibcudf/api_docs}/round.rst | 0 .../api_docs/pylibcudf => pylibcudf/api_docs}/scalar.rst | 0 .../api_docs/pylibcudf => pylibcudf/api_docs}/search.rst | 0 .../pylibcudf => pylibcudf/api_docs}/sorting.rst | 0 .../api_docs}/stream_compaction.rst | 0 .../api_docs}/strings/capitalize.rst | 0 .../api_docs}/strings/char_types.rst | 0 .../pylibcudf => pylibcudf/api_docs}/strings/combine.rst | 0 .../api_docs}/strings/contains.rst | 0 .../api_docs}/strings/convert/convert_booleans.rst | 0 .../api_docs}/strings/convert/convert_datetime.rst | 0 .../api_docs}/strings/convert/convert_durations.rst | 0 .../api_docs}/strings/convert/convert_fixed_point.rst | 0 .../api_docs}/strings/convert/convert_floats.rst | 0 .../api_docs}/strings/convert/convert_integers.rst | 0 .../api_docs}/strings/convert/convert_ipv4.rst | 0 .../api_docs}/strings/convert/convert_lists.rst | 0 .../api_docs}/strings/convert/convert_urls.rst | 0 .../api_docs}/strings/convert/index.rst | 0 .../pylibcudf => pylibcudf/api_docs}/strings/extract.rst | 0 .../pylibcudf => pylibcudf/api_docs}/strings/find.rst | 0 .../api_docs}/strings/find_multiple.rst | 0 .../pylibcudf => pylibcudf/api_docs}/strings/findall.rst | 0 .../pylibcudf => pylibcudf/api_docs}/strings/index.rst | 0 .../pylibcudf => pylibcudf/api_docs}/strings/padding.rst | 0 .../api_docs}/strings/regex_flags.rst | 0 .../api_docs}/strings/regex_program.rst | 0 .../pylibcudf => pylibcudf/api_docs}/strings/repeat.rst | 0 .../pylibcudf => pylibcudf/api_docs}/strings/replace.rst | 0 .../api_docs}/strings/replace_re.rst | 0 .../api_docs}/strings/side_type.rst | 0 .../pylibcudf => pylibcudf/api_docs}/strings/slice.rst | 0 .../pylibcudf => pylibcudf/api_docs}/strings/split.rst | 0 .../pylibcudf => pylibcudf/api_docs}/strings/strip.rst | 0 .../pylibcudf => pylibcudf/api_docs}/strings/wrap.rst | 0 .../api_docs/pylibcudf => pylibcudf/api_docs}/table.rst | 0 .../api_docs/pylibcudf => pylibcudf/api_docs}/traits.rst | 0 .../pylibcudf => pylibcudf/api_docs}/transform.rst | 0 .../pylibcudf => pylibcudf/api_docs}/transpose.rst | 0 .../api_docs/pylibcudf => pylibcudf/api_docs}/types.rst | 0 .../api_docs/pylibcudf => pylibcudf/api_docs}/unary.rst | 0 .../pylibcudf.md => pylibcudf/developer_docs.rst} | 2 +- docs/cudf/source/pylibcudf/index.rst | 9 +++++++++ docs/cudf/source/user_guide/api_docs/index.rst | 1 - 93 files changed, 16 insertions(+), 6 deletions(-) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/aggregation.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/binaryop.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/column.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/column_factories.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/concatenate.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/copying.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/datetime.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/expressions.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/filling.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/gpumemoryview.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/groupby.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/hashing.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/index.rst (94%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/interop.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/io/avro.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/io/csv.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/io/index.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/io/json.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/io/parquet.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/io/parquet_metadata.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/io/text.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/io/timezone.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/join.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/json.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/labeling.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/lists.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/merge.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/null_mask.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/nvtext/byte_pair_encode.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/nvtext/edit_distance.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/nvtext/generate_ngrams.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/nvtext/index.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/nvtext/jaccard.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/nvtext/minhash.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/nvtext/ngrams_tokenize.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/nvtext/normalize.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/nvtext/replace.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/nvtext/stemmer.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/nvtext/subword_tokenize.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/nvtext/tokenize.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/partitioning.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/quantiles.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/reduce.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/replace.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/reshape.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/rolling.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/round.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/scalar.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/search.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/sorting.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/stream_compaction.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/strings/capitalize.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/strings/char_types.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/strings/combine.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/strings/contains.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/strings/convert/convert_booleans.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/strings/convert/convert_datetime.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/strings/convert/convert_durations.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/strings/convert/convert_fixed_point.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/strings/convert/convert_floats.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/strings/convert/convert_integers.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/strings/convert/convert_ipv4.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/strings/convert/convert_lists.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/strings/convert/convert_urls.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/strings/convert/index.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/strings/extract.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/strings/find.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/strings/find_multiple.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/strings/findall.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/strings/index.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/strings/padding.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/strings/regex_flags.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/strings/regex_program.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/strings/repeat.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/strings/replace.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/strings/replace_re.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/strings/side_type.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/strings/slice.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/strings/split.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/strings/strip.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/strings/wrap.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/table.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/traits.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/transform.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/transpose.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/types.rst (100%) rename docs/cudf/source/{user_guide/api_docs/pylibcudf => pylibcudf/api_docs}/unary.rst (100%) rename docs/cudf/source/{developer_guide/pylibcudf.md => pylibcudf/developer_docs.rst} (99%) create mode 100644 docs/cudf/source/pylibcudf/index.rst diff --git a/docs/cudf/source/developer_guide/index.md b/docs/cudf/source/developer_guide/index.md index 5e099631fc5..a1cc1c9d586 100644 --- a/docs/cudf/source/developer_guide/index.md +++ b/docs/cudf/source/developer_guide/index.md @@ -26,6 +26,5 @@ documentation testing benchmarking options -pylibcudf cudf_pandas ``` diff --git a/docs/cudf/source/developer_guide/library_design.md b/docs/cudf/source/developer_guide/library_design.md index b2c9ddf9fe4..95b65eda0da 100644 --- a/docs/cudf/source/developer_guide/library_design.md +++ b/docs/cudf/source/developer_guide/library_design.md @@ -273,6 +273,8 @@ To have each worker in dask print spill statistics, do something like: ## The Cython layer +> **_NOTE:_** Most of the functionality in the Cython layer has been moved to pylibcudf. All that remains is the Column layer which will be removed in a future release. + The lowest level of cuDF is its interaction with `libcudf` via Cython. The Cython layer is composed of two components: C++ bindings and Cython wrappers. The first component consists of [`.pxd` files](https://cython.readthedocs.io/en/latest/src/tutorial/pxd_files.html), diff --git a/docs/cudf/source/index.rst b/docs/cudf/source/index.rst index 1b86cafeb48..6ce7c8dceb8 100644 --- a/docs/cudf/source/index.rst +++ b/docs/cudf/source/index.rst @@ -30,5 +30,6 @@ other operations. user_guide/index cudf_pandas/index cudf_polars/index + pylibcudf/index libcudf_docs/index developer_guide/index diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/aggregation.rst b/docs/cudf/source/pylibcudf/api_docs/aggregation.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/aggregation.rst rename to docs/cudf/source/pylibcudf/api_docs/aggregation.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/binaryop.rst b/docs/cudf/source/pylibcudf/api_docs/binaryop.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/binaryop.rst rename to docs/cudf/source/pylibcudf/api_docs/binaryop.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/column.rst b/docs/cudf/source/pylibcudf/api_docs/column.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/column.rst rename to docs/cudf/source/pylibcudf/api_docs/column.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/column_factories.rst b/docs/cudf/source/pylibcudf/api_docs/column_factories.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/column_factories.rst rename to docs/cudf/source/pylibcudf/api_docs/column_factories.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/concatenate.rst b/docs/cudf/source/pylibcudf/api_docs/concatenate.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/concatenate.rst rename to docs/cudf/source/pylibcudf/api_docs/concatenate.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/copying.rst b/docs/cudf/source/pylibcudf/api_docs/copying.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/copying.rst rename to docs/cudf/source/pylibcudf/api_docs/copying.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/datetime.rst b/docs/cudf/source/pylibcudf/api_docs/datetime.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/datetime.rst rename to docs/cudf/source/pylibcudf/api_docs/datetime.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/expressions.rst b/docs/cudf/source/pylibcudf/api_docs/expressions.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/expressions.rst rename to docs/cudf/source/pylibcudf/api_docs/expressions.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/filling.rst b/docs/cudf/source/pylibcudf/api_docs/filling.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/filling.rst rename to docs/cudf/source/pylibcudf/api_docs/filling.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/gpumemoryview.rst b/docs/cudf/source/pylibcudf/api_docs/gpumemoryview.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/gpumemoryview.rst rename to docs/cudf/source/pylibcudf/api_docs/gpumemoryview.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/groupby.rst b/docs/cudf/source/pylibcudf/api_docs/groupby.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/groupby.rst rename to docs/cudf/source/pylibcudf/api_docs/groupby.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/hashing.rst b/docs/cudf/source/pylibcudf/api_docs/hashing.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/hashing.rst rename to docs/cudf/source/pylibcudf/api_docs/hashing.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/index.rst b/docs/cudf/source/pylibcudf/api_docs/index.rst similarity index 94% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/index.rst rename to docs/cudf/source/pylibcudf/api_docs/index.rst index 997ece6d29c..04e2d199f75 100644 --- a/docs/cudf/source/user_guide/api_docs/pylibcudf/index.rst +++ b/docs/cudf/source/pylibcudf/api_docs/index.rst @@ -1,6 +1,6 @@ -========= -pylibcudf -========= +============= +API Reference +============= This page provides API documentation for pylibcudf. diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/interop.rst b/docs/cudf/source/pylibcudf/api_docs/interop.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/interop.rst rename to docs/cudf/source/pylibcudf/api_docs/interop.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/io/avro.rst b/docs/cudf/source/pylibcudf/api_docs/io/avro.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/io/avro.rst rename to docs/cudf/source/pylibcudf/api_docs/io/avro.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/io/csv.rst b/docs/cudf/source/pylibcudf/api_docs/io/csv.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/io/csv.rst rename to docs/cudf/source/pylibcudf/api_docs/io/csv.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/io/index.rst b/docs/cudf/source/pylibcudf/api_docs/io/index.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/io/index.rst rename to docs/cudf/source/pylibcudf/api_docs/io/index.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/io/json.rst b/docs/cudf/source/pylibcudf/api_docs/io/json.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/io/json.rst rename to docs/cudf/source/pylibcudf/api_docs/io/json.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/io/parquet.rst b/docs/cudf/source/pylibcudf/api_docs/io/parquet.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/io/parquet.rst rename to docs/cudf/source/pylibcudf/api_docs/io/parquet.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/io/parquet_metadata.rst b/docs/cudf/source/pylibcudf/api_docs/io/parquet_metadata.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/io/parquet_metadata.rst rename to docs/cudf/source/pylibcudf/api_docs/io/parquet_metadata.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/io/text.rst b/docs/cudf/source/pylibcudf/api_docs/io/text.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/io/text.rst rename to docs/cudf/source/pylibcudf/api_docs/io/text.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/io/timezone.rst b/docs/cudf/source/pylibcudf/api_docs/io/timezone.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/io/timezone.rst rename to docs/cudf/source/pylibcudf/api_docs/io/timezone.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/join.rst b/docs/cudf/source/pylibcudf/api_docs/join.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/join.rst rename to docs/cudf/source/pylibcudf/api_docs/join.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/json.rst b/docs/cudf/source/pylibcudf/api_docs/json.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/json.rst rename to docs/cudf/source/pylibcudf/api_docs/json.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/labeling.rst b/docs/cudf/source/pylibcudf/api_docs/labeling.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/labeling.rst rename to docs/cudf/source/pylibcudf/api_docs/labeling.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/lists.rst b/docs/cudf/source/pylibcudf/api_docs/lists.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/lists.rst rename to docs/cudf/source/pylibcudf/api_docs/lists.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/merge.rst b/docs/cudf/source/pylibcudf/api_docs/merge.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/merge.rst rename to docs/cudf/source/pylibcudf/api_docs/merge.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/null_mask.rst b/docs/cudf/source/pylibcudf/api_docs/null_mask.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/null_mask.rst rename to docs/cudf/source/pylibcudf/api_docs/null_mask.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/nvtext/byte_pair_encode.rst b/docs/cudf/source/pylibcudf/api_docs/nvtext/byte_pair_encode.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/nvtext/byte_pair_encode.rst rename to docs/cudf/source/pylibcudf/api_docs/nvtext/byte_pair_encode.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/nvtext/edit_distance.rst b/docs/cudf/source/pylibcudf/api_docs/nvtext/edit_distance.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/nvtext/edit_distance.rst rename to docs/cudf/source/pylibcudf/api_docs/nvtext/edit_distance.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/nvtext/generate_ngrams.rst b/docs/cudf/source/pylibcudf/api_docs/nvtext/generate_ngrams.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/nvtext/generate_ngrams.rst rename to docs/cudf/source/pylibcudf/api_docs/nvtext/generate_ngrams.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/nvtext/index.rst b/docs/cudf/source/pylibcudf/api_docs/nvtext/index.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/nvtext/index.rst rename to docs/cudf/source/pylibcudf/api_docs/nvtext/index.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/nvtext/jaccard.rst b/docs/cudf/source/pylibcudf/api_docs/nvtext/jaccard.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/nvtext/jaccard.rst rename to docs/cudf/source/pylibcudf/api_docs/nvtext/jaccard.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/nvtext/minhash.rst b/docs/cudf/source/pylibcudf/api_docs/nvtext/minhash.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/nvtext/minhash.rst rename to docs/cudf/source/pylibcudf/api_docs/nvtext/minhash.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/nvtext/ngrams_tokenize.rst b/docs/cudf/source/pylibcudf/api_docs/nvtext/ngrams_tokenize.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/nvtext/ngrams_tokenize.rst rename to docs/cudf/source/pylibcudf/api_docs/nvtext/ngrams_tokenize.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/nvtext/normalize.rst b/docs/cudf/source/pylibcudf/api_docs/nvtext/normalize.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/nvtext/normalize.rst rename to docs/cudf/source/pylibcudf/api_docs/nvtext/normalize.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/nvtext/replace.rst b/docs/cudf/source/pylibcudf/api_docs/nvtext/replace.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/nvtext/replace.rst rename to docs/cudf/source/pylibcudf/api_docs/nvtext/replace.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/nvtext/stemmer.rst b/docs/cudf/source/pylibcudf/api_docs/nvtext/stemmer.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/nvtext/stemmer.rst rename to docs/cudf/source/pylibcudf/api_docs/nvtext/stemmer.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/nvtext/subword_tokenize.rst b/docs/cudf/source/pylibcudf/api_docs/nvtext/subword_tokenize.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/nvtext/subword_tokenize.rst rename to docs/cudf/source/pylibcudf/api_docs/nvtext/subword_tokenize.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/nvtext/tokenize.rst b/docs/cudf/source/pylibcudf/api_docs/nvtext/tokenize.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/nvtext/tokenize.rst rename to docs/cudf/source/pylibcudf/api_docs/nvtext/tokenize.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/partitioning.rst b/docs/cudf/source/pylibcudf/api_docs/partitioning.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/partitioning.rst rename to docs/cudf/source/pylibcudf/api_docs/partitioning.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/quantiles.rst b/docs/cudf/source/pylibcudf/api_docs/quantiles.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/quantiles.rst rename to docs/cudf/source/pylibcudf/api_docs/quantiles.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/reduce.rst b/docs/cudf/source/pylibcudf/api_docs/reduce.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/reduce.rst rename to docs/cudf/source/pylibcudf/api_docs/reduce.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/replace.rst b/docs/cudf/source/pylibcudf/api_docs/replace.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/replace.rst rename to docs/cudf/source/pylibcudf/api_docs/replace.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/reshape.rst b/docs/cudf/source/pylibcudf/api_docs/reshape.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/reshape.rst rename to docs/cudf/source/pylibcudf/api_docs/reshape.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/rolling.rst b/docs/cudf/source/pylibcudf/api_docs/rolling.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/rolling.rst rename to docs/cudf/source/pylibcudf/api_docs/rolling.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/round.rst b/docs/cudf/source/pylibcudf/api_docs/round.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/round.rst rename to docs/cudf/source/pylibcudf/api_docs/round.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/scalar.rst b/docs/cudf/source/pylibcudf/api_docs/scalar.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/scalar.rst rename to docs/cudf/source/pylibcudf/api_docs/scalar.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/search.rst b/docs/cudf/source/pylibcudf/api_docs/search.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/search.rst rename to docs/cudf/source/pylibcudf/api_docs/search.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/sorting.rst b/docs/cudf/source/pylibcudf/api_docs/sorting.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/sorting.rst rename to docs/cudf/source/pylibcudf/api_docs/sorting.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/stream_compaction.rst b/docs/cudf/source/pylibcudf/api_docs/stream_compaction.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/stream_compaction.rst rename to docs/cudf/source/pylibcudf/api_docs/stream_compaction.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/strings/capitalize.rst b/docs/cudf/source/pylibcudf/api_docs/strings/capitalize.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/strings/capitalize.rst rename to docs/cudf/source/pylibcudf/api_docs/strings/capitalize.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/strings/char_types.rst b/docs/cudf/source/pylibcudf/api_docs/strings/char_types.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/strings/char_types.rst rename to docs/cudf/source/pylibcudf/api_docs/strings/char_types.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/strings/combine.rst b/docs/cudf/source/pylibcudf/api_docs/strings/combine.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/strings/combine.rst rename to docs/cudf/source/pylibcudf/api_docs/strings/combine.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/strings/contains.rst b/docs/cudf/source/pylibcudf/api_docs/strings/contains.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/strings/contains.rst rename to docs/cudf/source/pylibcudf/api_docs/strings/contains.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/strings/convert/convert_booleans.rst b/docs/cudf/source/pylibcudf/api_docs/strings/convert/convert_booleans.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/strings/convert/convert_booleans.rst rename to docs/cudf/source/pylibcudf/api_docs/strings/convert/convert_booleans.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/strings/convert/convert_datetime.rst b/docs/cudf/source/pylibcudf/api_docs/strings/convert/convert_datetime.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/strings/convert/convert_datetime.rst rename to docs/cudf/source/pylibcudf/api_docs/strings/convert/convert_datetime.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/strings/convert/convert_durations.rst b/docs/cudf/source/pylibcudf/api_docs/strings/convert/convert_durations.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/strings/convert/convert_durations.rst rename to docs/cudf/source/pylibcudf/api_docs/strings/convert/convert_durations.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/strings/convert/convert_fixed_point.rst b/docs/cudf/source/pylibcudf/api_docs/strings/convert/convert_fixed_point.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/strings/convert/convert_fixed_point.rst rename to docs/cudf/source/pylibcudf/api_docs/strings/convert/convert_fixed_point.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/strings/convert/convert_floats.rst b/docs/cudf/source/pylibcudf/api_docs/strings/convert/convert_floats.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/strings/convert/convert_floats.rst rename to docs/cudf/source/pylibcudf/api_docs/strings/convert/convert_floats.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/strings/convert/convert_integers.rst b/docs/cudf/source/pylibcudf/api_docs/strings/convert/convert_integers.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/strings/convert/convert_integers.rst rename to docs/cudf/source/pylibcudf/api_docs/strings/convert/convert_integers.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/strings/convert/convert_ipv4.rst b/docs/cudf/source/pylibcudf/api_docs/strings/convert/convert_ipv4.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/strings/convert/convert_ipv4.rst rename to docs/cudf/source/pylibcudf/api_docs/strings/convert/convert_ipv4.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/strings/convert/convert_lists.rst b/docs/cudf/source/pylibcudf/api_docs/strings/convert/convert_lists.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/strings/convert/convert_lists.rst rename to docs/cudf/source/pylibcudf/api_docs/strings/convert/convert_lists.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/strings/convert/convert_urls.rst b/docs/cudf/source/pylibcudf/api_docs/strings/convert/convert_urls.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/strings/convert/convert_urls.rst rename to docs/cudf/source/pylibcudf/api_docs/strings/convert/convert_urls.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/strings/convert/index.rst b/docs/cudf/source/pylibcudf/api_docs/strings/convert/index.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/strings/convert/index.rst rename to docs/cudf/source/pylibcudf/api_docs/strings/convert/index.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/strings/extract.rst b/docs/cudf/source/pylibcudf/api_docs/strings/extract.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/strings/extract.rst rename to docs/cudf/source/pylibcudf/api_docs/strings/extract.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/strings/find.rst b/docs/cudf/source/pylibcudf/api_docs/strings/find.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/strings/find.rst rename to docs/cudf/source/pylibcudf/api_docs/strings/find.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/strings/find_multiple.rst b/docs/cudf/source/pylibcudf/api_docs/strings/find_multiple.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/strings/find_multiple.rst rename to docs/cudf/source/pylibcudf/api_docs/strings/find_multiple.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/strings/findall.rst b/docs/cudf/source/pylibcudf/api_docs/strings/findall.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/strings/findall.rst rename to docs/cudf/source/pylibcudf/api_docs/strings/findall.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/strings/index.rst b/docs/cudf/source/pylibcudf/api_docs/strings/index.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/strings/index.rst rename to docs/cudf/source/pylibcudf/api_docs/strings/index.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/strings/padding.rst b/docs/cudf/source/pylibcudf/api_docs/strings/padding.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/strings/padding.rst rename to docs/cudf/source/pylibcudf/api_docs/strings/padding.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/strings/regex_flags.rst b/docs/cudf/source/pylibcudf/api_docs/strings/regex_flags.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/strings/regex_flags.rst rename to docs/cudf/source/pylibcudf/api_docs/strings/regex_flags.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/strings/regex_program.rst b/docs/cudf/source/pylibcudf/api_docs/strings/regex_program.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/strings/regex_program.rst rename to docs/cudf/source/pylibcudf/api_docs/strings/regex_program.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/strings/repeat.rst b/docs/cudf/source/pylibcudf/api_docs/strings/repeat.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/strings/repeat.rst rename to docs/cudf/source/pylibcudf/api_docs/strings/repeat.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/strings/replace.rst b/docs/cudf/source/pylibcudf/api_docs/strings/replace.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/strings/replace.rst rename to docs/cudf/source/pylibcudf/api_docs/strings/replace.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/strings/replace_re.rst b/docs/cudf/source/pylibcudf/api_docs/strings/replace_re.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/strings/replace_re.rst rename to docs/cudf/source/pylibcudf/api_docs/strings/replace_re.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/strings/side_type.rst b/docs/cudf/source/pylibcudf/api_docs/strings/side_type.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/strings/side_type.rst rename to docs/cudf/source/pylibcudf/api_docs/strings/side_type.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/strings/slice.rst b/docs/cudf/source/pylibcudf/api_docs/strings/slice.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/strings/slice.rst rename to docs/cudf/source/pylibcudf/api_docs/strings/slice.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/strings/split.rst b/docs/cudf/source/pylibcudf/api_docs/strings/split.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/strings/split.rst rename to docs/cudf/source/pylibcudf/api_docs/strings/split.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/strings/strip.rst b/docs/cudf/source/pylibcudf/api_docs/strings/strip.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/strings/strip.rst rename to docs/cudf/source/pylibcudf/api_docs/strings/strip.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/strings/wrap.rst b/docs/cudf/source/pylibcudf/api_docs/strings/wrap.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/strings/wrap.rst rename to docs/cudf/source/pylibcudf/api_docs/strings/wrap.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/table.rst b/docs/cudf/source/pylibcudf/api_docs/table.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/table.rst rename to docs/cudf/source/pylibcudf/api_docs/table.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/traits.rst b/docs/cudf/source/pylibcudf/api_docs/traits.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/traits.rst rename to docs/cudf/source/pylibcudf/api_docs/traits.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/transform.rst b/docs/cudf/source/pylibcudf/api_docs/transform.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/transform.rst rename to docs/cudf/source/pylibcudf/api_docs/transform.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/transpose.rst b/docs/cudf/source/pylibcudf/api_docs/transpose.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/transpose.rst rename to docs/cudf/source/pylibcudf/api_docs/transpose.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/types.rst b/docs/cudf/source/pylibcudf/api_docs/types.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/types.rst rename to docs/cudf/source/pylibcudf/api_docs/types.rst diff --git a/docs/cudf/source/user_guide/api_docs/pylibcudf/unary.rst b/docs/cudf/source/pylibcudf/api_docs/unary.rst similarity index 100% rename from docs/cudf/source/user_guide/api_docs/pylibcudf/unary.rst rename to docs/cudf/source/pylibcudf/api_docs/unary.rst diff --git a/docs/cudf/source/developer_guide/pylibcudf.md b/docs/cudf/source/pylibcudf/developer_docs.rst similarity index 99% rename from docs/cudf/source/developer_guide/pylibcudf.md rename to docs/cudf/source/pylibcudf/developer_docs.rst index 1ee828e7c4e..cce0d0b25b8 100644 --- a/docs/cudf/source/developer_guide/pylibcudf.md +++ b/docs/cudf/source/pylibcudf/developer_docs.rst @@ -1,4 +1,4 @@ -# pylibcudf +# Developer Documentation pylibcudf is a lightweight Cython wrapper around libcudf. It aims to provide a near-zero overhead interface to accessing libcudf in Python. diff --git a/docs/cudf/source/pylibcudf/index.rst b/docs/cudf/source/pylibcudf/index.rst new file mode 100644 index 00000000000..cfce538bb22 --- /dev/null +++ b/docs/cudf/source/pylibcudf/index.rst @@ -0,0 +1,9 @@ +pylibcudf documentation +======================= + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + api_docs/index.rst + developer_docs diff --git a/docs/cudf/source/user_guide/api_docs/index.rst b/docs/cudf/source/user_guide/api_docs/index.rst index f711327f9ed..249a41ade17 100644 --- a/docs/cudf/source/user_guide/api_docs/index.rst +++ b/docs/cudf/source/user_guide/api_docs/index.rst @@ -25,5 +25,4 @@ This page provides a list of all publicly accessible modules, methods and classe struct_handling options extension_dtypes - pylibcudf/index.rst performance_tracking