ray/doc
mehrdadn b14728d999
Shellcheck quoting (#9596)
* Fix SC2006: Use $(...) notation instead of legacy backticked `...`.

* Fix SC2016: Expressions don't expand in single quotes, use double quotes for that.

* Fix SC2046: Quote this to prevent word splitting.

* Fix SC2053: Quote the right-hand side of == in [[ ]] to prevent glob matching.

* Fix SC2068: Double quote array expansions to avoid re-splitting elements.

* Fix SC2086: Double quote to prevent globbing and word splitting.

* Fix SC2102: Ranges can only match single chars (mentioned due to duplicates).

* Fix SC2140: Word is of the form "A"B"C" (B indicated). Did you mean "ABC" or "A\"B\"C"?

* Fix SC2145: Argument mixes string and array. Use * or separate argument.

* Fix SC2209: warning: Use var=$(command) to assign output (or quote to assign string).

Co-authored-by: Mehrdad <noreply@github.com>
2020-07-21 21:56:41 -05:00
..
_build Get Sphinx infrastructure in place 2016-07-01 18:21:02 -07:00
azure Shellcheck quoting (#9596) 2020-07-21 21:56:41 -05:00
dev Shellcheck quoting (#9596) 2020-07-21 21:56:41 -05:00
examples Shellcheck quoting (#9596) 2020-07-21 21:56:41 -05:00
kubernetes Change os.uname()[1] and socket.gethostname() to the portable and faster platform.node_ip() (#8839) 2020-06-08 21:29:46 -07:00
site Replace all instances of ray.readthedocs.io with ray.io (#7994) 2020-04-13 16:17:05 -07:00
source [Serve] Document Metric Infrastructure (#9389) 2020-07-21 14:52:18 -07:00
tools Shellcheck quoting (#9596) 2020-07-21 21:56:41 -05:00
yarn Change os.uname()[1] and socket.gethostname() to the portable and faster platform.node_ip() (#8839) 2020-06-08 21:29:46 -07:00
.gitignore [docs] Convert Examples to Gallery (#5414) 2019-09-24 15:46:56 -07:00
make.bat Get Sphinx infrastructure in place 2016-07-01 18:21:02 -07:00
Makefile [tune] New Doc edits, add Concepts page (#8083) 2020-04-25 18:25:56 -07:00
README.md [RLlib] Fix use_lstm flag for ModelV2 (w/o ModelV1 wrapping) and add it for PyTorch. (#8734) 2020-06-05 15:40:30 +02:00
requirements-doc.txt [tune] pin tune-sklearn (#9498) 2020-07-17 21:25:12 -07:00
requirements-rtd.txt [docs] Fix readthedocs rendering (#7810) 2020-03-30 11:40:08 -07: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
make html
open _build/html/index.html

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

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