ray/doc
Kai Yang 4a55d10bb1
[Dataset] [DataFrame 2/n] Add pandas block format implementation (partial) (#20988)
This PR adds pandas block format support by implementing `PandasRow`, `PandasBlockBuilder`, `PandasBlockAccessor`.

Note that `sort_and_partition`, `combine`, `merge_sorted_blocks`, `aggregate_combined_blocks` in `PandasBlockAccessor` redirects to arrow block format implementation for now. They'll be implemented in a later PR.

Co-authored-by: Clark Zinzow <clarkzinzow@gmail.com>
Co-authored-by: Eric Liang <ekhliang@gmail.com>
2022-01-15 17:28:34 +08:00
..
_build Get Sphinx infrastructure in place 2016-07-01 18:21:02 -07:00
azure Updates to azure autoscaler for authentication and dependency updates (#19603) 2021-12-16 09:23:32 -08:00
examples [Dataset] [DataFrame 2/n] Add pandas block format implementation (partial) (#20988) 2022-01-15 17:28:34 +08:00
kubernetes [Core][CoreWorker] increase the default port range (#19541) 2021-11-05 09:25:44 -07:00
source [docs] Make Jobs more prominent in documentation (#21575) 2022-01-13 23:49:34 -08:00
tools Shellcheck rewrites (#9597) 2020-07-24 17:24:19 -05:00
yarn [core] Deprecate QuotaAwareEvictionPolicy (#16911) 2021-07-07 13:44:41 -07:00
.gitignore [docs] Convert Examples to Gallery (#5414) 2019-09-24 15:46:56 -07:00
BUILD [train][datasets] add example for big data training (#20042) 2021-11-05 09:28:48 -07:00
make.bat Get Sphinx infrastructure in place 2016-07-01 18:21:02 -07:00
Makefile [Core][Dataset] adding example for large scale data ingestion (#18998) 2021-10-11 15:37:09 -07:00
README.md [doc] Fix sklearn doc error, introduce MyST markdown parser (#21527) 2022-01-12 15:17:28 -08:00
requirements-doc.txt [CI] pin uvicorn to 0.16.0 to fix serve (#21612) 2022-01-14 16:00:51 -08:00
requirements-rtd.txt [doc] Fix sklearn doc error, introduce MyST markdown parser (#21527) 2022-01-12 15:17:28 -08:00

Ray Documentation

To compile the documentation, run the following commands from this directory. Note that Ray must be installed first.

pip install -r requirements-doc.txt
pip install -U -r requirements-rtd.txt # important for reproducing the deployment environment
make html
open _build/html/index.html

To test if there are any build errors with the documentation, do the following.

sphinx-build -W -b html -d _build/doctrees source _build/html

To check if there are broken links, run the following (we are currently not running this in the CI since there are false positives).

make linkcheck