diff --git a/ci/build_docs.sh b/ci/build_docs.sh index 67d611340c5..ceab29c2473 100755 --- a/ci/build_docs.sh +++ b/ci/build_docs.sh @@ -1,5 +1,5 @@ #!/bin/bash -# Copyright (c) 2023, NVIDIA CORPORATION. +# Copyright (c) 2023-2024, NVIDIA CORPORATION. set -euo pipefail @@ -40,8 +40,8 @@ popd rapids-logger "Build Python docs" pushd docs/cudf -make dirhtml -make text +make dirhtml O="-j 4" +make text O="-j 4" mkdir -p "${RAPIDS_DOCS_DIR}/cudf/"{html,txt} mv build/dirhtml/* "${RAPIDS_DOCS_DIR}/cudf/html" mv build/text/* "${RAPIDS_DOCS_DIR}/cudf/txt" diff --git a/conda/environments/all_cuda-118_arch-x86_64.yaml b/conda/environments/all_cuda-118_arch-x86_64.yaml index a5e3ea4c531..15bcf207b1b 100644 --- a/conda/environments/all_cuda-118_arch-x86_64.yaml +++ b/conda/environments/all_cuda-118_arch-x86_64.yaml @@ -12,6 +12,7 @@ dependencies: - benchmark==1.8.0 - boto3>=1.21.21 - botocore>=1.24.21 +- breathe>=4.35.0 - c-compiler - cachetools - clang-tools=16.0.6 diff --git a/conda/environments/all_cuda-120_arch-x86_64.yaml b/conda/environments/all_cuda-120_arch-x86_64.yaml index 579bbb6d52d..ccad6a366fb 100644 --- a/conda/environments/all_cuda-120_arch-x86_64.yaml +++ b/conda/environments/all_cuda-120_arch-x86_64.yaml @@ -12,6 +12,7 @@ dependencies: - benchmark==1.8.0 - boto3>=1.21.21 - botocore>=1.24.21 +- breathe>=4.35.0 - c-compiler - cachetools - clang-tools=16.0.6 diff --git a/cpp/doxygen/developer_guide/TESTING.md b/cpp/doxygen/developer_guide/TESTING.md index c19976a956b..a4ffe0f575b 100644 --- a/cpp/doxygen/developer_guide/TESTING.md +++ b/cpp/doxygen/developer_guide/TESTING.md @@ -464,9 +464,9 @@ the host (`to_host`). ### Background -libcudf employs a custom-built [preload library -docs](https://man7.org/linux/man-pages/man8/ld.so.8.html) to validate its internal stream usage (the -code may be found +libcudf employs a custom-built [preload +library](https://man7.org/linux/man-pages/man8/ld.so.8.html) to validate its internal stream usage +(the code may be found [`here`](https://github.com/rapidsai/cudf/blob/main/cpp/tests/utilities/identify_stream_usage.cpp)). This library wraps every asynchronous CUDA runtime API call that accepts a stream with a check to ensure that the passed CUDA stream is a valid one, immediately throwing an exception if an invalid diff --git a/cpp/include/cudf/strings/strings_column_view.hpp b/cpp/include/cudf/strings/strings_column_view.hpp index 36054f7c229..e6546777f3f 100644 --- a/cpp/include/cudf/strings/strings_column_view.hpp +++ b/cpp/include/cudf/strings/strings_column_view.hpp @@ -106,7 +106,7 @@ class strings_column_view : private column_view { /** * @brief Returns the internal column of chars * - * @throw cudf::logic error if this is an empty column + * @throw cudf::logic_error if this is an empty column * @param stream CUDA stream used for device memory operations and kernel launches * @return The chars column */ diff --git a/dependencies.yaml b/dependencies.yaml index 20998847a75..1c6d5086bf3 100644 --- a/dependencies.yaml +++ b/dependencies.yaml @@ -457,6 +457,7 @@ dependencies: common: - output_types: [conda] packages: + - breathe>=4.35.0 - dask-cuda==24.2.* - *doxygen - make diff --git a/docs/cudf/source/conf.py b/docs/cudf/source/conf.py index d98d1fa5d81..b997c78fba8 100644 --- a/docs/cudf/source/conf.py +++ b/docs/cudf/source/conf.py @@ -1,4 +1,4 @@ -# Copyright (c) 2018-2023, NVIDIA CORPORATION. +# Copyright (c) 2018-2024, NVIDIA CORPORATION. # # cudf documentation build configuration file, created by # sphinx-quickstart on Wed May 3 10:59:22 2017. @@ -16,11 +16,33 @@ # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. # +import glob import os +import re import sys +import xml.etree.ElementTree as ET from docutils.nodes import Text from sphinx.addnodes import pending_xref +from sphinx.highlighting import lexers +from sphinx.ext import intersphinx +from pygments.lexer import RegexLexer +from pygments.token import Text as PText + + +class PseudoLexer(RegexLexer): + """Trivial lexer for pseudocode.""" + + name = 'pseudocode' + aliases = ['pseudo'] + tokens = { + 'root': [ + (r'.*\n', PText), + ] + } + + +lexers['pseudo'] = PseudoLexer() # -- Custom Extensions ---------------------------------------------------- sys.path.append(os.path.abspath("./_ext")) @@ -35,6 +57,7 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ + "breathe", "sphinx.ext.intersphinx", "sphinx.ext.autodoc", "sphinx.ext.autosummary", @@ -46,6 +69,67 @@ "myst_nb", ] +# Preprocess doxygen xml for compatibility with latest Breathe +def clean_definitions(root): + # Breathe can't handle SFINAE properly: + # https://github.com/breathe-doc/breathe/issues/624 + seen_ids = set() + for sectiondef in root.findall(".//sectiondef"): + for memberdef in sectiondef.findall("./memberdef"): + id_ = memberdef.get("id") + for tparamlist in memberdef.findall("./templateparamlist"): + for param in tparamlist.findall("./param"): + for type_ in param.findall("./type"): + # CUDF_ENABLE_IF or std::enable_if + if "enable_if" in ET.tostring(type_).decode().lower(): + if id_ not in seen_ids: + # If this is the first time we're seeing this function, + # just remove the template parameter. + seen_ids.add(id_) + tparamlist.remove(param) + else: + # Otherwise, remove the overload altogether and just + # rely on documenting one of the SFINAE overloads. + sectiondef.remove(memberdef) + break + + # In addition to enable_if, check for overloads set up by + # ...*=nullptr. + for type_ in param.findall("./defval"): + if "nullptr" in ET.tostring(type_).decode(): + try: + tparamlist.remove(param) + except ValueError: + # May have already been removed in above, + # so skip. + pass + break + + + # All of these in type declarations cause Breathe to choke. + # For friend, see https://github.com/breathe-doc/breathe/issues/916 + strings_to_remove = ("__forceinline__", "CUDF_HOST_DEVICE", "decltype(auto)", "friend") + for field in (".//type", ".//definition"): + for type_ in root.findall(field): + if type_.text is not None: + for string in strings_to_remove: + type_.text = type_.text.replace(string, "") + + +def clean_all_xml_files(path): + for fn in glob.glob(os.path.join(path, "*.xml")): + tree = ET.parse(fn) + clean_definitions(tree.getroot()) + tree.write(fn) + + +# Breathe Configuration +breathe_projects = {"libcudf": "../../../cpp/doxygen/xml"} +for project_path in breathe_projects.values(): + clean_all_xml_files(project_path) +breathe_default_project = "libcudf" + + nb_execution_excludepatterns = ['performance-comparisons.ipynb'] nb_execution_mode = "force" @@ -195,11 +279,13 @@ # Example configuration for intersphinx: refer to the Python standard library. intersphinx_mapping = { - "python": ("https://docs.python.org/3", None), "cupy": ("https://docs.cupy.dev/en/stable/", None), + "dlpack": ("https://dmlc.github.io/dlpack/latest/", None), "numpy": ("https://numpy.org/doc/stable", None), - "pyarrow": ("https://arrow.apache.org/docs/", None), "pandas": ("https://pandas.pydata.org/docs/", None), + "pyarrow": ("https://arrow.apache.org/docs/", None), + "python": ("https://docs.python.org/3", None), + "rmm": ("https://docs.rapids.ai/api/rmm/nightly/", None), "typing_extensions": ("https://typing-extensions.readthedocs.io/en/stable/", None), } @@ -238,14 +324,170 @@ def resolve_aliases(app, doctree): text_node.parent.replace(text_node, Text(text_to_render, "")) -def ignore_internal_references(app, env, node, contnode): - name = node.get("reftarget", None) - if name == "cudf.core.index.GenericIndex": +def _generate_namespaces(namespaces): + all_namespaces = [] + for base_namespace, other_namespaces in namespaces.items(): + all_namespaces.append(base_namespace + "::") + for other_namespace in other_namespaces: + all_namespaces.append(f"{other_namespace}::") + all_namespaces.append(f"{base_namespace}::{other_namespace}::") + return all_namespaces + +_all_namespaces = _generate_namespaces({ + # Note that io::datasource is actually a nested class + "cudf": {"io", "io::datasource", "strings", "ast", "ast::expression"}, + "numeric": {}, + "nvtext": {}, +}) + +_names_to_skip = { + # External names + "thrust", + "cuda", + "arrow", + # Unknown types + "int8_t", + "int16_t", + "int32_t", + "int64_t", + "__int128_t", + "size_t", + "uint8_t", + "uint16_t", + "uint32_t", + "uint64_t", + # Internal objects + "id_to_type_impl", + "type_to_scalar_type_impl", + "type_to_scalar_type_impl", + "detail", + # kafka objects + "python_callable_type", + "kafka_oauth_callback_wrapper_type", + # Template types + "Radix", + # Unsupported by Breathe + # https://github.com/breathe-doc/breathe/issues/355 + "deprecated", + # TODO: This type is currently defined in a detail header but it's in + # the public namespace. However, it's used in the detail header, so it + # needs to be put into a public header that can be shared. + "char_utf8", + # TODO: This is currently in a src file but perhaps should be public + "orc::column_statistics", + # Sphinx doesn't know how to distinguish between the ORC and Parquet + # definitions because Breathe doesn't to preserve namespaces for enums. + "TypeKind", +} + +_domain_objects = None +_prefixed_domain_objects = None +_intersphinx_cache = {} + +_intersphinx_extra_prefixes = ("rmm", "rmm::mr", "mr") + + +def _cached_intersphinx_lookup(env, node, contnode): + """Perform an intersphinx lookup and cache the result. + + Have to manually manage the intersphinx cache because lru_cache doesn't + handle the env object properly. + """ + key = (node, contnode) + if key in _intersphinx_cache: + return _intersphinx_cache[key] + if (ref := intersphinx.resolve_reference_detect_inventory(env, node, contnode)) is not None: + _intersphinx_cache[key] = ref + return ref + + +def on_missing_reference(app, env, node, contnode): + # These variables are defined outside the function to speed up the build. + global _all_namespaces, _names_to_skip, _intersphinx_extra_prefixes, \ + _domain_objects, _prefixed_domain_objects, _intersphinx_cache + + # Precompute and cache domains for faster lookups + if _domain_objects is None: + _domain_objects = {} + _prefixed_domain_objects = {} + for (name, _, _, docname, _, _) in env.domains["cpp"].get_objects(): + _domain_objects[name] = docname + for prefix in _all_namespaces: + _prefixed_domain_objects[f"{prefix}{name}"] = name + + reftarget = node.get("reftarget") + if reftarget == "cudf.core.index.GenericIndex": # We don't exposed docs for `cudf.core.index.GenericIndex` # hence we would want the docstring & mypy references to # use `cudf.Index` node["reftarget"] = "cudf.Index" return contnode + if "namespacecudf" in reftarget: + node["reftarget"] = "cudf" + return contnode + if "classcudf_1_1column__device__view_" in reftarget: + node["reftarget"] = "cudf::column_device_view" + return contnode + + if (refid := node.get("refid")) is not None and "hpp" in refid: + # We don't want to link to C++ header files directly from the + # Sphinx docs, those are pages that doxygen automatically + # generates. Adding those would clutter the Sphinx output. + return contnode + + if node["refdomain"] in ("std", "cpp") and reftarget is not None: + if any(toskip in reftarget for toskip in _names_to_skip): + return contnode + + # Strip template parameters and just use the base type. + if match := re.search("(.*)<.*>", reftarget): + reftarget = match.group(1) + + # Try to find the target prefixed with e.g. namespaces in case that's + # all that's missing. + # We need to do this search because the call sites may not have used + # the namespaces and we don't want to force them to, and we have to + # consider both directions because of issues like + # https://github.com/breathe-doc/breathe/issues/860 + # (there may be other related issues, I haven't investigated all + # possible combinations of failures in depth). + if (name := _prefixed_domain_objects.get(reftarget)) is None: + for prefix in _all_namespaces: + if f"{prefix}{reftarget}" in _domain_objects: + name = f"{prefix}{reftarget}" + break + if name is not None: + return env.domains["cpp"].resolve_xref( + env, + _domain_objects[name], + app.builder, + node["reftype"], + name, + node, + contnode, + ) + + # Final possibility is an intersphinx lookup to see if the symbol + # exists in one of the other inventories. First we check the symbol + # itself in case it was originally templated and that caused the lookup + # to fail. + if reftarget != node["reftarget"]: + node["reftarget"] = reftarget + if (ref := _cached_intersphinx_lookup(env, node, contnode)) is not None: + return ref + + # If the template wasn't the (only) issue, we check the various + # namespace prefixes that may need to be added or removed. + for prefix in _intersphinx_extra_prefixes: + if prefix not in reftarget: + node["reftarget"] = f"{prefix}::{reftarget}" + if (ref := _cached_intersphinx_lookup(env, node, contnode)) is not None: + return ref + else: + node["reftarget"] = reftarget.replace(f"{prefix}::", "") + if (ref := _cached_intersphinx_lookup(env, node, contnode)) is not None: + return ref + return None @@ -261,4 +503,4 @@ def setup(app): app.add_css_file("https://docs.rapids.ai/assets/css/custom.css") app.add_js_file("https://docs.rapids.ai/assets/js/custom.js", loading_method="defer") app.connect("doctree-read", resolve_aliases) - app.connect("missing-reference", ignore_internal_references) + app.connect("missing-reference", on_missing_reference) diff --git a/docs/cudf/source/index.rst b/docs/cudf/source/index.rst index 21badd683af..3765b560a7f 100644 --- a/docs/cudf/source/index.rst +++ b/docs/cudf/source/index.rst @@ -29,4 +29,5 @@ other operations. user_guide/index cudf_pandas/index + libcudf_docs/index developer_guide/index diff --git a/docs/cudf/source/libcudf_docs/api_docs/aggregation_factories.rst b/docs/cudf/source/libcudf_docs/api_docs/aggregation_factories.rst new file mode 100644 index 00000000000..49677acc730 --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/aggregation_factories.rst @@ -0,0 +1,5 @@ +Aggregation Factories +===================== + +.. doxygengroup:: aggregation_factories + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/aggregation_groupby.rst b/docs/cudf/source/libcudf_docs/api_docs/aggregation_groupby.rst new file mode 100644 index 00000000000..5af85e5d74a --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/aggregation_groupby.rst @@ -0,0 +1,5 @@ +Aggregation Groupby +=================== + +.. doxygengroup:: aggregation_groupby + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/aggregation_reduction.rst b/docs/cudf/source/libcudf_docs/api_docs/aggregation_reduction.rst new file mode 100644 index 00000000000..e0f5046fe61 --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/aggregation_reduction.rst @@ -0,0 +1,5 @@ +Aggregation Reduction +===================== + +.. doxygengroup:: aggregation_reduction + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/aggregation_rolling.rst b/docs/cudf/source/libcudf_docs/api_docs/aggregation_rolling.rst new file mode 100644 index 00000000000..962f332adc3 --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/aggregation_rolling.rst @@ -0,0 +1,5 @@ +Aggregation Rolling +=================== + +.. doxygengroup:: aggregation_rolling + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/column_aggregation.rst b/docs/cudf/source/libcudf_docs/api_docs/column_aggregation.rst new file mode 100644 index 00000000000..39c0fdd5d3c --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/column_aggregation.rst @@ -0,0 +1,14 @@ +Column Aggregation +================== + +.. doxygengroup:: column_aggregation + :members: + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + aggregation_factories + aggregation_reduction + aggregation_groupby + aggregation_rolling diff --git a/docs/cudf/source/libcudf_docs/api_docs/column_apis.rst b/docs/cudf/source/libcudf_docs/api_docs/column_apis.rst new file mode 100644 index 00000000000..23660576a37 --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/column_apis.rst @@ -0,0 +1,23 @@ +Column APIs +=========== + +.. doxygengroup:: column_apis + :members: + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + column_copy + column_nullmask + column_sort + column_search + column_hash + column_merge + column_join + column_quantiles + column_aggregation + column_transformation + column_reshape + column_reorder + column_interop diff --git a/docs/cudf/source/libcudf_docs/api_docs/column_classes.rst b/docs/cudf/source/libcudf_docs/api_docs/column_classes.rst new file mode 100644 index 00000000000..cc3ed8c6626 --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/column_classes.rst @@ -0,0 +1,16 @@ +Column Classes +============== + +.. doxygengroup:: column_classes + :members: + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + column_factories + dictionary_classes + lists_classes + strings_classes + structs_classes + timestamp_classes diff --git a/docs/cudf/source/libcudf_docs/api_docs/column_copy.rst b/docs/cudf/source/libcudf_docs/api_docs/column_copy.rst new file mode 100644 index 00000000000..a8bc72fc505 --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/column_copy.rst @@ -0,0 +1,16 @@ +Column Copy +=========== + +.. doxygengroup:: column_copy + :members: + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + copy_concatenate + copy_gather + copy_scatter + copy_slice + copy_split + copy_shift diff --git a/docs/cudf/source/libcudf_docs/api_docs/column_factories.rst b/docs/cudf/source/libcudf_docs/api_docs/column_factories.rst new file mode 100644 index 00000000000..938db2a40a5 --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/column_factories.rst @@ -0,0 +1,5 @@ +Column Factories +================ + +.. doxygengroup:: column_factories + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/column_hash.rst b/docs/cudf/source/libcudf_docs/api_docs/column_hash.rst new file mode 100644 index 00000000000..cd0c2838474 --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/column_hash.rst @@ -0,0 +1,5 @@ +Column Hash +=========== + +.. doxygengroup:: column_hash + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/column_interop.rst b/docs/cudf/source/libcudf_docs/api_docs/column_interop.rst new file mode 100644 index 00000000000..dd6036b0339 --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/column_interop.rst @@ -0,0 +1,12 @@ +Column Interop +============== + +.. doxygengroup:: column_interop + :members: + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + interop_dlpack + interop_arrow diff --git a/docs/cudf/source/libcudf_docs/api_docs/column_join.rst b/docs/cudf/source/libcudf_docs/api_docs/column_join.rst new file mode 100644 index 00000000000..903319f4881 --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/column_join.rst @@ -0,0 +1,5 @@ +Column Join +=========== + +.. doxygengroup:: column_join + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/column_merge.rst b/docs/cudf/source/libcudf_docs/api_docs/column_merge.rst new file mode 100644 index 00000000000..0f12ad3d169 --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/column_merge.rst @@ -0,0 +1,5 @@ +Column Merge +============ + +.. doxygengroup:: column_merge + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/column_nullmask.rst b/docs/cudf/source/libcudf_docs/api_docs/column_nullmask.rst new file mode 100644 index 00000000000..35c94e0b03e --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/column_nullmask.rst @@ -0,0 +1,5 @@ +Column Nullmask +=============== + +.. doxygengroup:: column_nullmask + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/column_quantiles.rst b/docs/cudf/source/libcudf_docs/api_docs/column_quantiles.rst new file mode 100644 index 00000000000..f1e1b3f843e --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/column_quantiles.rst @@ -0,0 +1,5 @@ +Column Quantiles +================ + +.. doxygengroup:: column_quantiles + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/column_reorder.rst b/docs/cudf/source/libcudf_docs/api_docs/column_reorder.rst new file mode 100644 index 00000000000..ccc8a48f7df --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/column_reorder.rst @@ -0,0 +1,12 @@ +Column Reorder +============== + +.. doxygengroup:: column_reorder + :members: + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + reorder_partition + reorder_compact diff --git a/docs/cudf/source/libcudf_docs/api_docs/column_reshape.rst b/docs/cudf/source/libcudf_docs/api_docs/column_reshape.rst new file mode 100644 index 00000000000..59df1eaa5b9 --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/column_reshape.rst @@ -0,0 +1,11 @@ +Column Reshape +============== + +.. doxygengroup:: column_reshape + :members: + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + reshape_transpose diff --git a/docs/cudf/source/libcudf_docs/api_docs/column_search.rst b/docs/cudf/source/libcudf_docs/api_docs/column_search.rst new file mode 100644 index 00000000000..1997c5618e3 --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/column_search.rst @@ -0,0 +1,5 @@ +Column Search +============= + +.. doxygengroup:: column_search + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/column_sort.rst b/docs/cudf/source/libcudf_docs/api_docs/column_sort.rst new file mode 100644 index 00000000000..4d8fe895109 --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/column_sort.rst @@ -0,0 +1,5 @@ +Column Sort +=========== + +.. doxygengroup:: column_sort + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/column_transformation.rst b/docs/cudf/source/libcudf_docs/api_docs/column_transformation.rst new file mode 100644 index 00000000000..e2da7e5ad28 --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/column_transformation.rst @@ -0,0 +1,15 @@ +Column Transformation +===================== + +.. doxygengroup:: column_transformation + :members: + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + transformation_unaryops + transformation_binaryops + transformation_transform + transformation_replace + transformation_fill diff --git a/docs/cudf/source/libcudf_docs/api_docs/copy_concatenate.rst b/docs/cudf/source/libcudf_docs/api_docs/copy_concatenate.rst new file mode 100644 index 00000000000..f9400bff9e8 --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/copy_concatenate.rst @@ -0,0 +1,5 @@ +Copy Concatenate +================ + +.. doxygengroup:: copy_concatenate + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/copy_gather.rst b/docs/cudf/source/libcudf_docs/api_docs/copy_gather.rst new file mode 100644 index 00000000000..daf306caa6e --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/copy_gather.rst @@ -0,0 +1,5 @@ +Copy Gather +=========== + +.. doxygengroup:: copy_gather + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/copy_scatter.rst b/docs/cudf/source/libcudf_docs/api_docs/copy_scatter.rst new file mode 100644 index 00000000000..d7b9a461901 --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/copy_scatter.rst @@ -0,0 +1,5 @@ +Copy Scatter +============ + +.. doxygengroup:: copy_scatter + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/copy_shift.rst b/docs/cudf/source/libcudf_docs/api_docs/copy_shift.rst new file mode 100644 index 00000000000..5187100a8a6 --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/copy_shift.rst @@ -0,0 +1,5 @@ +Copy Shift +========== + +.. doxygengroup:: copy_shift + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/copy_slice.rst b/docs/cudf/source/libcudf_docs/api_docs/copy_slice.rst new file mode 100644 index 00000000000..3fb2fbe49d0 --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/copy_slice.rst @@ -0,0 +1,5 @@ +Copy Slice +========== + +.. doxygengroup:: copy_slice + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/copy_split.rst b/docs/cudf/source/libcudf_docs/api_docs/copy_split.rst new file mode 100644 index 00000000000..ddcdfd31cc4 --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/copy_split.rst @@ -0,0 +1,5 @@ +Copy Split +========== + +.. doxygengroup:: copy_split + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/cudf_classes.rst b/docs/cudf/source/libcudf_docs/api_docs/cudf_classes.rst new file mode 100644 index 00000000000..5473dd56ebb --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/cudf_classes.rst @@ -0,0 +1,14 @@ +Cudf Classes +============ + +.. doxygengroup:: cudf_classes + :members: + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + column_classes + table_classes + scalar_classes + fixed_point_classes diff --git a/docs/cudf/source/libcudf_docs/api_docs/cudf_namespace.rst b/docs/cudf/source/libcudf_docs/api_docs/cudf_namespace.rst new file mode 100644 index 00000000000..fd4f3c9b6ab --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/cudf_namespace.rst @@ -0,0 +1,28 @@ +libcudf +======= + +.. TODO: This page really only exists right now for the purpose of resolving namespace links. We may want to just ignore these instead + +.. doxygennamespace:: cudf + :desc-only: + +.. doxygennamespace:: cudf::ast + :desc-only: + +.. doxygennamespace:: cudf::io + :desc-only: + +.. doxygennamespace:: cudf::io::orc + :desc-only: + +.. doxygennamespace:: cudf::io::parquet + :desc-only: + +.. doxygennamespace:: cudf::hashing + :desc-only: + +.. doxygennamespace:: numeric + :desc-only: + +.. doxygennamespace:: cudf::tdigest + :desc-only: diff --git a/docs/cudf/source/libcudf_docs/api_docs/datetime_apis.rst b/docs/cudf/source/libcudf_docs/api_docs/datetime_apis.rst new file mode 100644 index 00000000000..8f7960444fc --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/datetime_apis.rst @@ -0,0 +1,12 @@ +Datetime APIs +============= + +.. doxygengroup:: datetime_apis + :members: + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + datetime_extract + datetime_compute diff --git a/docs/cudf/source/libcudf_docs/api_docs/datetime_compute.rst b/docs/cudf/source/libcudf_docs/api_docs/datetime_compute.rst new file mode 100644 index 00000000000..0c7ba0f522f --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/datetime_compute.rst @@ -0,0 +1,5 @@ +Datetime Compute +================ + +.. doxygengroup:: datetime_compute + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/datetime_extract.rst b/docs/cudf/source/libcudf_docs/api_docs/datetime_extract.rst new file mode 100644 index 00000000000..da212480abc --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/datetime_extract.rst @@ -0,0 +1,5 @@ +Datetime Extract +================ + +.. doxygengroup:: datetime_extract + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/default_stream.rst b/docs/cudf/source/libcudf_docs/api_docs/default_stream.rst new file mode 100644 index 00000000000..c50493a8f60 --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/default_stream.rst @@ -0,0 +1,5 @@ +Default Stream +============== + +.. doxygengroup:: default_stream + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/dictionary_apis.rst b/docs/cudf/source/libcudf_docs/api_docs/dictionary_apis.rst new file mode 100644 index 00000000000..8d463b0a956 --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/dictionary_apis.rst @@ -0,0 +1,13 @@ +Dictionary APIs +=============== + +.. doxygengroup:: dictionary_apis + :members: + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + dictionary_encode + dictionary_search + dictionary_update diff --git a/docs/cudf/source/libcudf_docs/api_docs/dictionary_classes.rst b/docs/cudf/source/libcudf_docs/api_docs/dictionary_classes.rst new file mode 100644 index 00000000000..00dec78c5f5 --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/dictionary_classes.rst @@ -0,0 +1,5 @@ +Dictionary Classes +================== + +.. doxygengroup:: dictionary_classes + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/dictionary_encode.rst b/docs/cudf/source/libcudf_docs/api_docs/dictionary_encode.rst new file mode 100644 index 00000000000..ed77380f281 --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/dictionary_encode.rst @@ -0,0 +1,5 @@ +Dictionary Encode +================= + +.. doxygengroup:: dictionary_encode + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/dictionary_search.rst b/docs/cudf/source/libcudf_docs/api_docs/dictionary_search.rst new file mode 100644 index 00000000000..b187d29ca0b --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/dictionary_search.rst @@ -0,0 +1,5 @@ +Dictionary Search +================= + +.. doxygengroup:: dictionary_search + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/dictionary_update.rst b/docs/cudf/source/libcudf_docs/api_docs/dictionary_update.rst new file mode 100644 index 00000000000..8b0c12c09d9 --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/dictionary_update.rst @@ -0,0 +1,5 @@ +Dictionary Update +================= + +.. doxygengroup:: dictionary_update + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/expressions.rst b/docs/cudf/source/libcudf_docs/api_docs/expressions.rst new file mode 100644 index 00000000000..c65d8a29858 --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/expressions.rst @@ -0,0 +1,5 @@ +Expression Evaluation +===================== + +.. doxygengroup:: expressions + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/fixed_point_classes.rst b/docs/cudf/source/libcudf_docs/api_docs/fixed_point_classes.rst new file mode 100644 index 00000000000..0a1ef1b4d63 --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/fixed_point_classes.rst @@ -0,0 +1,6 @@ + +Fixed Point Classes +=================== + +.. doxygengroup:: fixed_point_classes + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/index.rst b/docs/cudf/source/libcudf_docs/api_docs/index.rst new file mode 100644 index 00000000000..c077a7cd452 --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/index.rst @@ -0,0 +1,29 @@ +libcudf documentation +===================== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + cudf_namespace + default_stream + cudf_classes + column_apis + datetime_apis + strings_apis + dictionary_apis + io_apis + json_apis + lists_apis + nvtext_apis + utility_apis + labeling_apis + expressions + tdigest + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`search` diff --git a/docs/cudf/source/libcudf_docs/api_docs/interop_arrow.rst b/docs/cudf/source/libcudf_docs/api_docs/interop_arrow.rst new file mode 100644 index 00000000000..e0f0edfc9ae --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/interop_arrow.rst @@ -0,0 +1,5 @@ +Interop Arrow +============= + +.. doxygengroup:: interop_arrow + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/interop_dlpack.rst b/docs/cudf/source/libcudf_docs/api_docs/interop_dlpack.rst new file mode 100644 index 00000000000..4be168c5132 --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/interop_dlpack.rst @@ -0,0 +1,5 @@ +Interop Dlpack +============== + +.. doxygengroup:: interop_dlpack + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/io_apis.rst b/docs/cudf/source/libcudf_docs/api_docs/io_apis.rst new file mode 100644 index 00000000000..a23c0948584 --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/io_apis.rst @@ -0,0 +1,15 @@ +Io APIs +======= + +.. doxygengroup:: io_apis + :members: + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + io_types + io_readers + io_writers + io_datasources + io_datasinks diff --git a/docs/cudf/source/libcudf_docs/api_docs/io_datasinks.rst b/docs/cudf/source/libcudf_docs/api_docs/io_datasinks.rst new file mode 100644 index 00000000000..15b0da5f7a7 --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/io_datasinks.rst @@ -0,0 +1,5 @@ +Io Datasinks +============ + +.. doxygengroup:: io_datasinks + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/io_datasources.rst b/docs/cudf/source/libcudf_docs/api_docs/io_datasources.rst new file mode 100644 index 00000000000..3d5834892eb --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/io_datasources.rst @@ -0,0 +1,5 @@ +Io Datasources +============== + +.. doxygengroup:: io_datasources + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/io_readers.rst b/docs/cudf/source/libcudf_docs/api_docs/io_readers.rst new file mode 100644 index 00000000000..a835673dee4 --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/io_readers.rst @@ -0,0 +1,5 @@ +Io Readers +========== + +.. doxygengroup:: io_readers + :desc-only: diff --git a/docs/cudf/source/libcudf_docs/api_docs/io_types.rst b/docs/cudf/source/libcudf_docs/api_docs/io_types.rst new file mode 100644 index 00000000000..abdc43bc6fa --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/io_types.rst @@ -0,0 +1,5 @@ +Io Types +======== + +.. doxygengroup:: io_types + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/io_writers.rst b/docs/cudf/source/libcudf_docs/api_docs/io_writers.rst new file mode 100644 index 00000000000..add57ecfed4 --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/io_writers.rst @@ -0,0 +1,5 @@ +Io Writers +========== + +.. doxygengroup:: io_writers + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/json_apis.rst b/docs/cudf/source/libcudf_docs/api_docs/json_apis.rst new file mode 100644 index 00000000000..119dbc36fa1 --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/json_apis.rst @@ -0,0 +1,11 @@ +JSON APIs +========= + +.. doxygengroup:: json_apis + :members: + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + json_object diff --git a/docs/cudf/source/libcudf_docs/api_docs/json_object.rst b/docs/cudf/source/libcudf_docs/api_docs/json_object.rst new file mode 100644 index 00000000000..510a2f9eb07 --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/json_object.rst @@ -0,0 +1,5 @@ +JSON Object +=========== + +.. doxygengroup:: json_object + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/label_bins.rst b/docs/cudf/source/libcudf_docs/api_docs/label_bins.rst new file mode 100644 index 00000000000..ca80912e527 --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/label_bins.rst @@ -0,0 +1,5 @@ +Label Bins +========== + +.. doxygengroup:: label_bins + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/labeling_apis.rst b/docs/cudf/source/libcudf_docs/api_docs/labeling_apis.rst new file mode 100644 index 00000000000..24726ce2e09 --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/labeling_apis.rst @@ -0,0 +1,11 @@ +Labeling APIs +============= + +.. doxygengroup:: labeling_apis + :members: + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + label_bins diff --git a/docs/cudf/source/libcudf_docs/api_docs/lists_apis.rst b/docs/cudf/source/libcudf_docs/api_docs/lists_apis.rst new file mode 100644 index 00000000000..d34253d909a --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/lists_apis.rst @@ -0,0 +1,20 @@ +Lists APIs +========== + +.. doxygengroup:: lists_apis + :members: + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + lists_combine + lists_modify + lists_extract + lists_filling + lists_contains + lists_gather + lists_elements + lists_filtering + lists_sort + set_operations diff --git a/docs/cudf/source/libcudf_docs/api_docs/lists_classes.rst b/docs/cudf/source/libcudf_docs/api_docs/lists_classes.rst new file mode 100644 index 00000000000..9b89c164746 --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/lists_classes.rst @@ -0,0 +1,5 @@ +Lists Classes +============= + +.. doxygengroup:: lists_classes + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/lists_combine.rst b/docs/cudf/source/libcudf_docs/api_docs/lists_combine.rst new file mode 100644 index 00000000000..e26fd89a3c2 --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/lists_combine.rst @@ -0,0 +1,5 @@ +Lists Combine +============= + +.. doxygengroup:: lists_combine + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/lists_contains.rst b/docs/cudf/source/libcudf_docs/api_docs/lists_contains.rst new file mode 100644 index 00000000000..ccb1366a6fb --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/lists_contains.rst @@ -0,0 +1,5 @@ +Lists Contains +============== + +.. doxygengroup:: lists_contains + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/lists_elements.rst b/docs/cudf/source/libcudf_docs/api_docs/lists_elements.rst new file mode 100644 index 00000000000..fb7758a46d0 --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/lists_elements.rst @@ -0,0 +1,5 @@ +Lists Elements +============== + +.. doxygengroup:: lists_elements + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/lists_extract.rst b/docs/cudf/source/libcudf_docs/api_docs/lists_extract.rst new file mode 100644 index 00000000000..f721d89684e --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/lists_extract.rst @@ -0,0 +1,5 @@ +Lists Extract +============= + +.. doxygengroup:: lists_extract + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/lists_filling.rst b/docs/cudf/source/libcudf_docs/api_docs/lists_filling.rst new file mode 100644 index 00000000000..5ab3c491dbe --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/lists_filling.rst @@ -0,0 +1,5 @@ +Lists Filling +============= + +.. doxygengroup:: lists_filling + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/lists_filtering.rst b/docs/cudf/source/libcudf_docs/api_docs/lists_filtering.rst new file mode 100644 index 00000000000..af9f1ebaa2b --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/lists_filtering.rst @@ -0,0 +1,5 @@ +Lists Filtering +=============== + +.. doxygengroup:: lists_filtering + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/lists_gather.rst b/docs/cudf/source/libcudf_docs/api_docs/lists_gather.rst new file mode 100644 index 00000000000..4cb927b2672 --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/lists_gather.rst @@ -0,0 +1,5 @@ +Lists Gather +============ + +.. doxygengroup:: lists_gather + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/lists_modify.rst b/docs/cudf/source/libcudf_docs/api_docs/lists_modify.rst new file mode 100644 index 00000000000..d41020b75cd --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/lists_modify.rst @@ -0,0 +1,5 @@ +Lists Modify +============ + +.. doxygengroup:: lists_modify + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/lists_sort.rst b/docs/cudf/source/libcudf_docs/api_docs/lists_sort.rst new file mode 100644 index 00000000000..63de08d1622 --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/lists_sort.rst @@ -0,0 +1,5 @@ +Lists Sort +========== + +.. doxygengroup:: lists_sort + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/nvtext_apis.rst b/docs/cudf/source/libcudf_docs/api_docs/nvtext_apis.rst new file mode 100644 index 00000000000..f938f2914ed --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/nvtext_apis.rst @@ -0,0 +1,18 @@ +Nvtext APIs +=========== + +.. doxygengroup:: nvtext_apis + :members: + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + nvtext_ngrams + nvtext_normalize + nvtext_stemmer + nvtext_edit_distance + nvtext_tokenize + nvtext_replace + nvtext_minhash + nvtext_jaccard diff --git a/docs/cudf/source/libcudf_docs/api_docs/nvtext_edit_distance.rst b/docs/cudf/source/libcudf_docs/api_docs/nvtext_edit_distance.rst new file mode 100644 index 00000000000..e5eb2dc8c95 --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/nvtext_edit_distance.rst @@ -0,0 +1,5 @@ +Nvtext Edit Distance +==================== + +.. doxygengroup:: nvtext_edit_distance + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/nvtext_jaccard.rst b/docs/cudf/source/libcudf_docs/api_docs/nvtext_jaccard.rst new file mode 100644 index 00000000000..75124c5655a --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/nvtext_jaccard.rst @@ -0,0 +1,5 @@ +Nvtext Jaccard +============== + +.. doxygengroup:: nvtext_jaccard + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/nvtext_minhash.rst b/docs/cudf/source/libcudf_docs/api_docs/nvtext_minhash.rst new file mode 100644 index 00000000000..57d8445a3eb --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/nvtext_minhash.rst @@ -0,0 +1,5 @@ +Nvtext Minhash +============== + +.. doxygengroup:: nvtext_minhash + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/nvtext_ngrams.rst b/docs/cudf/source/libcudf_docs/api_docs/nvtext_ngrams.rst new file mode 100644 index 00000000000..27f93211f4c --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/nvtext_ngrams.rst @@ -0,0 +1,5 @@ +Nvtext Ngrams +============= + +.. doxygengroup:: nvtext_ngrams + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/nvtext_normalize.rst b/docs/cudf/source/libcudf_docs/api_docs/nvtext_normalize.rst new file mode 100644 index 00000000000..7654f3c19f6 --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/nvtext_normalize.rst @@ -0,0 +1,5 @@ +Nvtext Normalize +================ + +.. doxygengroup:: nvtext_normalize + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/nvtext_replace.rst b/docs/cudf/source/libcudf_docs/api_docs/nvtext_replace.rst new file mode 100644 index 00000000000..cdd2e45f48b --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/nvtext_replace.rst @@ -0,0 +1,5 @@ +Nvtext Replace +============== + +.. doxygengroup:: nvtext_replace + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/nvtext_stemmer.rst b/docs/cudf/source/libcudf_docs/api_docs/nvtext_stemmer.rst new file mode 100644 index 00000000000..fbe5675fe2d --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/nvtext_stemmer.rst @@ -0,0 +1,5 @@ +Nvtext Stemmer +============== + +.. doxygengroup:: nvtext_stemmer + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/nvtext_tokenize.rst b/docs/cudf/source/libcudf_docs/api_docs/nvtext_tokenize.rst new file mode 100644 index 00000000000..58fc422dc88 --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/nvtext_tokenize.rst @@ -0,0 +1,5 @@ +Nvtext Tokenize +=============== + +.. doxygengroup:: nvtext_tokenize + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/reorder_compact.rst b/docs/cudf/source/libcudf_docs/api_docs/reorder_compact.rst new file mode 100644 index 00000000000..099d08f74ab --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/reorder_compact.rst @@ -0,0 +1,5 @@ +Reorder Compact +=============== + +.. doxygengroup:: reorder_compact + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/reorder_partition.rst b/docs/cudf/source/libcudf_docs/api_docs/reorder_partition.rst new file mode 100644 index 00000000000..a8b88ab244f --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/reorder_partition.rst @@ -0,0 +1,5 @@ +Reorder Partition +================= + +.. doxygengroup:: reorder_partition + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/reshape_transpose.rst b/docs/cudf/source/libcudf_docs/api_docs/reshape_transpose.rst new file mode 100644 index 00000000000..1ab29129c33 --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/reshape_transpose.rst @@ -0,0 +1,5 @@ +Reshape Transpose +================= + +.. doxygengroup:: reshape_transpose + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/scalar_classes.rst b/docs/cudf/source/libcudf_docs/api_docs/scalar_classes.rst new file mode 100644 index 00000000000..3022e5d2292 --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/scalar_classes.rst @@ -0,0 +1,11 @@ +Scalar Classes +============== + +.. doxygengroup:: scalar_classes + :members: + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + scalar_factories diff --git a/docs/cudf/source/libcudf_docs/api_docs/scalar_factories.rst b/docs/cudf/source/libcudf_docs/api_docs/scalar_factories.rst new file mode 100644 index 00000000000..782ce6cb421 --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/scalar_factories.rst @@ -0,0 +1,5 @@ +Scalar Factories +================ + +.. doxygengroup:: scalar_factories + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/set_operations.rst b/docs/cudf/source/libcudf_docs/api_docs/set_operations.rst new file mode 100644 index 00000000000..22118daec00 --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/set_operations.rst @@ -0,0 +1,5 @@ +Set Operations +============== + +.. doxygengroup:: set_operations + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/strings_apis.rst b/docs/cudf/source/libcudf_docs/api_docs/strings_apis.rst new file mode 100644 index 00000000000..c42d5479954 --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/strings_apis.rst @@ -0,0 +1,23 @@ +Strings APIs +============ + +.. doxygengroup:: strings_apis + :members: + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + strings_case + strings_types + strings_combine + strings_contains + strings_convert + strings_copy + strings_slice + strings_find + strings_modify + strings_replace + strings_split + strings_extract + strings_regex diff --git a/docs/cudf/source/libcudf_docs/api_docs/strings_case.rst b/docs/cudf/source/libcudf_docs/api_docs/strings_case.rst new file mode 100644 index 00000000000..ddec78a268e --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/strings_case.rst @@ -0,0 +1,5 @@ +Strings Case +============ + +.. doxygengroup:: strings_case + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/strings_classes.rst b/docs/cudf/source/libcudf_docs/api_docs/strings_classes.rst new file mode 100644 index 00000000000..867b2ac242a --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/strings_classes.rst @@ -0,0 +1,5 @@ +Strings Classes +=============== + +.. doxygengroup:: strings_classes + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/strings_combine.rst b/docs/cudf/source/libcudf_docs/api_docs/strings_combine.rst new file mode 100644 index 00000000000..4542308e0c7 --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/strings_combine.rst @@ -0,0 +1,5 @@ +Strings Combine +=============== + +.. doxygengroup:: strings_combine + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/strings_contains.rst b/docs/cudf/source/libcudf_docs/api_docs/strings_contains.rst new file mode 100644 index 00000000000..250eb96e541 --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/strings_contains.rst @@ -0,0 +1,5 @@ +Strings Contains +================ + +.. doxygengroup:: strings_contains + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/strings_convert.rst b/docs/cudf/source/libcudf_docs/api_docs/strings_convert.rst new file mode 100644 index 00000000000..ae5d78fb1a1 --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/strings_convert.rst @@ -0,0 +1,5 @@ +Strings Convert +=============== + +.. doxygengroup:: strings_convert + :desc-only: diff --git a/docs/cudf/source/libcudf_docs/api_docs/strings_copy.rst b/docs/cudf/source/libcudf_docs/api_docs/strings_copy.rst new file mode 100644 index 00000000000..0c2884361bf --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/strings_copy.rst @@ -0,0 +1,5 @@ +Strings Copy +============ + +.. doxygengroup:: strings_copy + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/strings_extract.rst b/docs/cudf/source/libcudf_docs/api_docs/strings_extract.rst new file mode 100644 index 00000000000..8018bbc627a --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/strings_extract.rst @@ -0,0 +1,5 @@ +Strings Extract +=============== + +.. doxygengroup:: strings_extract + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/strings_find.rst b/docs/cudf/source/libcudf_docs/api_docs/strings_find.rst new file mode 100644 index 00000000000..709bd138f54 --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/strings_find.rst @@ -0,0 +1,5 @@ +Strings Find +============ + +.. doxygengroup:: strings_find + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/strings_modify.rst b/docs/cudf/source/libcudf_docs/api_docs/strings_modify.rst new file mode 100644 index 00000000000..4bf54e5e835 --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/strings_modify.rst @@ -0,0 +1,5 @@ +Strings Modify +============== + +.. doxygengroup:: strings_modify + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/strings_regex.rst b/docs/cudf/source/libcudf_docs/api_docs/strings_regex.rst new file mode 100644 index 00000000000..719b09be24e --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/strings_regex.rst @@ -0,0 +1,5 @@ +Strings Regex +============= + +.. doxygengroup:: strings_regex + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/strings_replace.rst b/docs/cudf/source/libcudf_docs/api_docs/strings_replace.rst new file mode 100644 index 00000000000..884295e6d78 --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/strings_replace.rst @@ -0,0 +1,5 @@ +Strings Replace +=============== + +.. doxygengroup:: strings_replace + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/strings_slice.rst b/docs/cudf/source/libcudf_docs/api_docs/strings_slice.rst new file mode 100644 index 00000000000..bc1831a9dd4 --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/strings_slice.rst @@ -0,0 +1,5 @@ +Strings Slice +============= + +.. doxygengroup:: strings_slice + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/strings_split.rst b/docs/cudf/source/libcudf_docs/api_docs/strings_split.rst new file mode 100644 index 00000000000..ddf7cf2f1d6 --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/strings_split.rst @@ -0,0 +1,5 @@ +Strings Split +============= + +.. doxygengroup:: strings_split + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/strings_types.rst b/docs/cudf/source/libcudf_docs/api_docs/strings_types.rst new file mode 100644 index 00000000000..aff356efb71 --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/strings_types.rst @@ -0,0 +1,5 @@ +Strings Types +============= + +.. doxygengroup:: strings_types + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/structs_classes.rst b/docs/cudf/source/libcudf_docs/api_docs/structs_classes.rst new file mode 100644 index 00000000000..2669c2884d6 --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/structs_classes.rst @@ -0,0 +1,5 @@ +Structs Classes +=============== + +.. doxygengroup:: structs_classes + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/table_classes.rst b/docs/cudf/source/libcudf_docs/api_docs/table_classes.rst new file mode 100644 index 00000000000..f00e315e597 --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/table_classes.rst @@ -0,0 +1,5 @@ +Table Classes +============= + +.. doxygengroup:: table_classes + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/tdigest.rst b/docs/cudf/source/libcudf_docs/api_docs/tdigest.rst new file mode 100644 index 00000000000..9eb97df8337 --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/tdigest.rst @@ -0,0 +1,5 @@ +tdigest +======= + +.. doxygengroup:: tdigest + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/timestamp_classes.rst b/docs/cudf/source/libcudf_docs/api_docs/timestamp_classes.rst new file mode 100644 index 00000000000..4651d8dbd32 --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/timestamp_classes.rst @@ -0,0 +1,5 @@ +Timestamp Classes +================= + +.. doxygengroup:: timestamp_classes + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/transformation_binaryops.rst b/docs/cudf/source/libcudf_docs/api_docs/transformation_binaryops.rst new file mode 100644 index 00000000000..59be3a7b45e --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/transformation_binaryops.rst @@ -0,0 +1,5 @@ +Transformation Binaryops +======================== + +.. doxygengroup:: transformation_binaryops + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/transformation_fill.rst b/docs/cudf/source/libcudf_docs/api_docs/transformation_fill.rst new file mode 100644 index 00000000000..939fba261df --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/transformation_fill.rst @@ -0,0 +1,5 @@ +Transformation Fill +=================== + +.. doxygengroup:: transformation_fill + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/transformation_replace.rst b/docs/cudf/source/libcudf_docs/api_docs/transformation_replace.rst new file mode 100644 index 00000000000..6800b7bba76 --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/transformation_replace.rst @@ -0,0 +1,5 @@ +Transformation Replace +====================== + +.. doxygengroup:: transformation_replace + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/transformation_transform.rst b/docs/cudf/source/libcudf_docs/api_docs/transformation_transform.rst new file mode 100644 index 00000000000..108a680f5a1 --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/transformation_transform.rst @@ -0,0 +1,5 @@ +Transformation Transform +======================== + +.. doxygengroup:: transformation_transform + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/transformation_unaryops.rst b/docs/cudf/source/libcudf_docs/api_docs/transformation_unaryops.rst new file mode 100644 index 00000000000..07b5ba6388b --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/transformation_unaryops.rst @@ -0,0 +1,5 @@ +Transformation Unaryops +======================= + +.. doxygengroup:: transformation_unaryops + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/utility_apis.rst b/docs/cudf/source/libcudf_docs/api_docs/utility_apis.rst new file mode 100644 index 00000000000..9f0cda74582 --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/utility_apis.rst @@ -0,0 +1,15 @@ +Utility APIs +============ + +.. doxygengroup:: utility_apis + :members: + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + utility_types + utility_dispatcher + utility_bitmask + utility_error + utility_span diff --git a/docs/cudf/source/libcudf_docs/api_docs/utility_bitmask.rst b/docs/cudf/source/libcudf_docs/api_docs/utility_bitmask.rst new file mode 100644 index 00000000000..5dba1928baf --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/utility_bitmask.rst @@ -0,0 +1,5 @@ +Utility Bitmask +=============== + +.. doxygengroup:: utility_bitmask + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/utility_dispatcher.rst b/docs/cudf/source/libcudf_docs/api_docs/utility_dispatcher.rst new file mode 100644 index 00000000000..539505e4551 --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/utility_dispatcher.rst @@ -0,0 +1,5 @@ +Utility Dispatcher +================== + +.. doxygengroup:: utility_dispatcher + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/utility_error.rst b/docs/cudf/source/libcudf_docs/api_docs/utility_error.rst new file mode 100644 index 00000000000..acb575636c9 --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/utility_error.rst @@ -0,0 +1,5 @@ +Utility Error +============= + +.. doxygengroup:: utility_error + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/utility_span.rst b/docs/cudf/source/libcudf_docs/api_docs/utility_span.rst new file mode 100644 index 00000000000..fdb1d254c0e --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/utility_span.rst @@ -0,0 +1,5 @@ +Utility Span +============ + +.. doxygengroup:: utility_span + :members: diff --git a/docs/cudf/source/libcudf_docs/api_docs/utility_types.rst b/docs/cudf/source/libcudf_docs/api_docs/utility_types.rst new file mode 100644 index 00000000000..f021535d589 --- /dev/null +++ b/docs/cudf/source/libcudf_docs/api_docs/utility_types.rst @@ -0,0 +1,5 @@ +Utility Types +============= + +.. doxygengroup:: utility_types + :members: diff --git a/docs/cudf/source/libcudf_docs/index.rst b/docs/cudf/source/libcudf_docs/index.rst new file mode 100644 index 00000000000..39ed46d8578 --- /dev/null +++ b/docs/cudf/source/libcudf_docs/index.rst @@ -0,0 +1,17 @@ +libcudf documentation +===================== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + api_docs/index.rst + md_regex + unicode_limitations + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`search` diff --git a/docs/cudf/source/libcudf_docs/md_regex.rst b/docs/cudf/source/libcudf_docs/md_regex.rst new file mode 100644 index 00000000000..0eb0f464063 --- /dev/null +++ b/docs/cudf/source/libcudf_docs/md_regex.rst @@ -0,0 +1,4 @@ +.. _md_regex: + +.. include:: ../../../../cpp/doxygen/regex.md + :parser: myst_parser.sphinx_ diff --git a/docs/cudf/source/libcudf_docs/unicode_limitations.rst b/docs/cudf/source/libcudf_docs/unicode_limitations.rst new file mode 100644 index 00000000000..1f069088160 --- /dev/null +++ b/docs/cudf/source/libcudf_docs/unicode_limitations.rst @@ -0,0 +1,4 @@ +.. _unicode_limitations: + +.. include:: ../../../../cpp/doxygen/unicode.md + :parser: myst_parser.sphinx_