Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix all warnings in Python docs #13789

Merged
merged 31 commits into from
Aug 7, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
31 commits
Select commit Hold shift + click to select a range
26039c3
Add in all missing Index methods
vyasr Jul 30, 2023
c4e3739
Disable autosummary for interval
vyasr Jul 30, 2023
971bbea
Fix some spacing
vyasr Jul 30, 2023
e82fd1e
Add missing DataFrame APIs
vyasr Jul 30, 2023
302f93c
Add missing index methods
vyasr Jul 30, 2023
22a43af
Fix Series methods other than accessors
vyasr Jul 30, 2023
31d970c
Document extension types
vyasr Jul 30, 2023
d6d24c2
Revert "Document extension types"
vyasr Jul 30, 2023
d67c371
Fix indentation issues in DataFrame
vyasr Jul 30, 2023
1e13f59
Add extra parquet and tokenizer functions
vyasr Jul 30, 2023
bf7262e
Add missing accessors
vyasr Jul 30, 2023
28d0dcf
Fix string methods.
vyasr Jul 30, 2023
5ee080c
Fix headers in 10min
vyasr Jul 30, 2023
da27ffc
Fix headers in cupy-interop
vyasr Jul 30, 2023
63bdb26
Nest substitutions under myst
vyasr Jul 30, 2023
75db830
Fix issues with dtypes
vyasr Jul 30, 2023
0383af7
Fix some links in Markdown
vyasr Jul 30, 2023
15116ad
Remaining misc fixes
vyasr Jul 30, 2023
fbb20a6
Fix final notebook error
vyasr Jul 30, 2023
a48465d
Some final small improvements
vyasr Jul 30, 2023
ab20e67
Make warnings errors in Makefile and CI builds
vyasr Jul 30, 2023
b2aab2f
Back to forcing notebook execution
vyasr Jul 30, 2023
bfb73c8
Add make to docs dependencies
vyasr Jul 31, 2023
497b4bd
Merge remote-tracking branch 'origin/branch-23.10' into feat/cleanup_…
vyasr Aug 1, 2023
affd406
Add missing docs dependencies
vyasr Aug 1, 2023
4f3435f
Allow warnings for dask-cudf
vyasr Aug 1, 2023
4ba9d6b
Match old paths
vyasr Aug 4, 2023
b3b8e29
Merge remote-tracking branch 'origin/branch-23.10' into feat/cleanup_…
vyasr Aug 4, 2023
8378870
Fix paths
vyasr Aug 4, 2023
32dff12
Fix cross-refs from md
vyasr Aug 4, 2023
ace1342
Merge branch 'branch-23.10' into feat/cleanup_docs
vyasr Aug 5, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions ci/build_docs.sh
Original file line number Diff line number Diff line change
Expand Up @@ -38,20 +38,20 @@ popd

rapids-logger "Build Python docs"
pushd docs/cudf
sphinx-build -b dirhtml source _html
sphinx-build -b text source _text
make dirhtml
make text
mkdir -p "${RAPIDS_DOCS_DIR}/cudf/"{html,txt}
mv _html/* "${RAPIDS_DOCS_DIR}/cudf/html"
mv _text/* "${RAPIDS_DOCS_DIR}/cudf/txt"
mv build/dirhtml/* "${RAPIDS_DOCS_DIR}/cudf/html"
mv build/text/* "${RAPIDS_DOCS_DIR}/cudf/txt"
popd

rapids-logger "Build dask-cuDF Sphinx docs"
pushd docs/dask_cudf
sphinx-build -b dirhtml source _html
sphinx-build -b text source _text
make dirhtml
make text
mkdir -p "${RAPIDS_DOCS_DIR}/dask-cudf/"{html,txt}
mv _html/* "${RAPIDS_DOCS_DIR}/dask-cudf/html"
mv _text/* "${RAPIDS_DOCS_DIR}/dask-cudf/txt"
mv build/dirhtml/* "${RAPIDS_DOCS_DIR}/dask-cudf/html"
mv build/text/* "${RAPIDS_DOCS_DIR}/dask-cudf/txt"
popd

rapids-upload-docs
1 change: 1 addition & 0 deletions conda/environments/all_cuda-118_arch-x86_64.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ dependencies:
- libkvikio==23.10.*
- librdkafka>=1.9.0,<1.10.0a0
- librmm==23.10.*
- make
- mimesis>=4.1.0
- moto>=4.0.8
- msgpack-python
Expand Down
1 change: 1 addition & 0 deletions conda/environments/all_cuda-120_arch-x86_64.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ dependencies:
- libkvikio==23.10.*
- librdkafka>=1.9.0,<1.10.0a0
- librmm==23.10.*
- make
- mimesis>=4.1.0
- moto>=4.0.8
- msgpack-python
Expand Down
3 changes: 3 additions & 0 deletions dependencies.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -374,12 +374,15 @@ dependencies:
common:
- output_types: [conda]
packages:
- dask-cuda==23.10.*
- doxygen=1.8.20
- make
- myst-nb
- nbsphinx
- numpydoc
- pandoc
- pydata-sphinx-theme
- scipy
- sphinx
- sphinx-autobuild
- sphinx-copybutton
Expand Down
2 changes: 1 addition & 1 deletion docs/cudf/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
#

# You can set these variables from the command line.
SPHINXOPTS = -n -v
SPHINXOPTS = -n -v -W --keep-going
SPHINXBUILD = sphinx-build
SPHINXPROJ = cudf
SOURCEDIR = source
Expand Down
11 changes: 10 additions & 1 deletion docs/cudf/source/api_docs/dataframe.rst
Original file line number Diff line number Diff line change
Expand Up @@ -149,9 +149,9 @@ Computations / descriptive stats
DataFrame.quantile
DataFrame.rank
DataFrame.round
DataFrame.scale
DataFrame.skew
DataFrame.sum
DataFrame.sum_of_squares
DataFrame.std
DataFrame.var
DataFrame.nunique
Expand Down Expand Up @@ -219,6 +219,7 @@ Reshaping, sorting, transposing
DataFrame.sort_index
DataFrame.nlargest
DataFrame.nsmallest
DataFrame.swaplevel
DataFrame.stack
DataFrame.unstack
DataFrame.melt
Expand Down Expand Up @@ -251,11 +252,17 @@ Serialization / IO / conversion
.. autosummary::
:toctree: api/

DataFrame.deserialize
DataFrame.device_deserialize
DataFrame.device_serialize
DataFrame.from_arrow
DataFrame.from_dict
DataFrame.from_pandas
DataFrame.from_records
DataFrame.hash_values
DataFrame.host_deserialize
DataFrame.host_serialize
DataFrame.serialize
DataFrame.to_arrow
DataFrame.to_dict
DataFrame.to_dlpack
Expand All @@ -270,3 +277,5 @@ Serialization / IO / conversion
DataFrame.to_feather
DataFrame.to_records
DataFrame.to_string
DataFrame.values
DataFrame.values_host
176 changes: 176 additions & 0 deletions docs/cudf/source/api_docs/extension_dtypes.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,176 @@
================
Extension Dtypes
================
.. currentmodule:: cudf.core.dtypes

cuDF supports a number of extension dtypes that build on top of the types that pandas supports. These dtypes are not directly available in pandas, which instead relies on object dtype arrays that run at Python rather than native speeds. The following dtypes are supported:


cudf.CategoricalDtype
=====================
.. autosummary::
:toctree: api/
:template: autosummary/class_without_autosummary.rst

CategoricalDtype


Properties and Methods
----------------------
.. autosummary::
:toctree: api/

CategoricalDtype.categories
CategoricalDtype.construct_from_string
CategoricalDtype.deserialize
CategoricalDtype.device_deserialize
CategoricalDtype.device_serialize
CategoricalDtype.from_pandas
CategoricalDtype.host_deserialize
CategoricalDtype.host_serialize
CategoricalDtype.is_dtype
CategoricalDtype.name
CategoricalDtype.ordered
CategoricalDtype.serialize
CategoricalDtype.str
CategoricalDtype.to_pandas
CategoricalDtype.type


cudf.Decimal32Dtype
===================
.. autosummary::
:toctree: api/
:template: autosummary/class_without_autosummary.rst

Decimal32Dtype

Properties and Methods
----------------------
.. autosummary::
:toctree: api/

Decimal32Dtype.ITEMSIZE
Decimal32Dtype.MAX_PRECISION
Decimal32Dtype.deserialize
Decimal32Dtype.device_deserialize
Decimal32Dtype.device_serialize
Decimal32Dtype.from_arrow
Decimal32Dtype.host_deserialize
Decimal32Dtype.host_serialize
Decimal32Dtype.is_dtype
Decimal32Dtype.itemsize
Decimal32Dtype.precision
Decimal32Dtype.scale
Decimal32Dtype.serialize
Decimal32Dtype.str
Decimal32Dtype.to_arrow

cudf.Decimal64Dtype
===================
.. autosummary::
:toctree: api/
:template: autosummary/class_without_autosummary.rst

Decimal64Dtype

Properties and Methods
----------------------
.. autosummary::
:toctree: api/

Decimal64Dtype.ITEMSIZE
Decimal64Dtype.MAX_PRECISION
Decimal64Dtype.deserialize
Decimal64Dtype.device_deserialize
Decimal64Dtype.device_serialize
Decimal64Dtype.from_arrow
Decimal64Dtype.host_deserialize
Decimal64Dtype.host_serialize
Decimal64Dtype.is_dtype
Decimal64Dtype.itemsize
Decimal64Dtype.precision
Decimal64Dtype.scale
Decimal64Dtype.serialize
Decimal64Dtype.str
Decimal64Dtype.to_arrow

cudf.Decimal128Dtype
====================
.. autosummary::
:toctree: api/
:template: autosummary/class_without_autosummary.rst

Decimal128Dtype

Properties and Methods
----------------------
.. autosummary::
:toctree: api/

Decimal128Dtype.ITEMSIZE
Decimal128Dtype.MAX_PRECISION
Decimal128Dtype.deserialize
Decimal128Dtype.device_deserialize
Decimal128Dtype.device_serialize
Decimal128Dtype.from_arrow
Decimal128Dtype.host_deserialize
Decimal128Dtype.host_serialize
Decimal128Dtype.is_dtype
Decimal128Dtype.itemsize
Decimal128Dtype.precision
Decimal128Dtype.scale
Decimal128Dtype.serialize
Decimal128Dtype.str
Decimal128Dtype.to_arrow

cudf.ListDtype
==============
.. autosummary::
:toctree: api/
:template: autosummary/class_without_autosummary.rst

ListDtype

Properties and Methods
----------------------
.. autosummary::
:toctree: api/

ListDtype.deserialize
ListDtype.device_deserialize
ListDtype.device_serialize
ListDtype.element_type
ListDtype.from_arrow
ListDtype.host_deserialize
ListDtype.host_serialize
ListDtype.is_dtype
ListDtype.leaf_type
ListDtype.serialize
ListDtype.to_arrow
ListDtype.type

cudf.StructDtype
================
.. autosummary::
:toctree: api/
:template: autosummary/class_without_autosummary.rst

StructDtype

Properties and Methods
----------------------
.. autosummary::
:toctree: api/

StructDtype.deserialize
StructDtype.device_deserialize
StructDtype.device_serialize
StructDtype.fields
StructDtype.from_arrow
StructDtype.host_deserialize
StructDtype.host_serialize
StructDtype.is_dtype
StructDtype.serialize
StructDtype.to_arrow
StructDtype.type
1 change: 1 addition & 0 deletions docs/cudf/source/api_docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,4 @@ This page provides a list of all publicly accessible modules, methods and classe
list_handling
struct_handling
options
extension_dtypes
20 changes: 18 additions & 2 deletions docs/cudf/source/api_docs/index_objects.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,10 @@ Properties
.. autosummary::
:toctree: api/

Index.dtype
Index.duplicated
Index.empty
Index.has_duplicates
Index.duplicated
Index.hasnans
Index.is_monotonic
Index.is_monotonic_increasing
Expand Down Expand Up @@ -52,7 +53,6 @@ Modifying and computations
Index.is_floating
Index.is_integer
Index.is_interval
Index.is_mixed
Index.is_numeric
Index.is_object
Index.min
Expand Down Expand Up @@ -93,6 +93,13 @@ Conversion
:toctree: api/

Index.astype
Index.deserialize
Index.device_deserialize
Index.device_serialize
Index.host_deserialize
Index.host_serialize
Index.serialize
Index.tolist
Index.to_arrow
Index.to_cupy
Index.to_list
Expand All @@ -110,6 +117,7 @@ Sorting
:toctree: api/

Index.argsort
Index.find_label_range
Index.searchsorted
Index.sort_values

Expand Down Expand Up @@ -141,6 +149,13 @@ Selecting
Index.get_slice_bound
Index.isin

String Operations
~~~~~~~~~~~~~~~~~
.. autosummary::
:toctree: api/

Index.str

.. _api.numericindex:

Numeric Index
Expand Down Expand Up @@ -185,6 +200,7 @@ IntervalIndex
-------------
.. autosummary::
:toctree: api/
:template: autosummary/class_without_autosummary.rst

IntervalIndex

Expand Down
2 changes: 2 additions & 0 deletions docs/cudf/source/api_docs/io.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,8 @@ Parquet
:template: autosummary/class_with_autosummary.rst

cudf.io.parquet.ParquetDatasetWriter
cudf.io.parquet.ParquetDatasetWriter.close
cudf.io.parquet.ParquetDatasetWriter.write_table


ORC
Expand Down
6 changes: 6 additions & 0 deletions docs/cudf/source/api_docs/list_handling.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@ List handling
lists and apply list methods to it. These can be accessed like
``Series.list.<function/property>``.

.. currentmodule:: cudf
.. autosummary::
:toctree: api/

Series.list

.. currentmodule:: cudf.core.column.lists.ListMethods
.. autosummary::
:toctree: api/
Expand Down
Loading