mirror of
https://github.com/vale981/ray
synced 2025-03-05 10:01:43 -05:00
56d2cf6479
* Fix SC2001: See if you can use ${variable//search/replace} instead.
* Fix SC2010: Don't use ls | grep. Use a glob or a for loop with a condition to allow non-alphanumeric filenames.
* Fix SC2012: Use find instead of ls to better handle non-alphanumeric filenames.
* Fix SC2015: Note that A && B || C is not if-then-else. C may run when A is true.
* Fix SC2028: echo may not expand escape sequences. Use printf.
* Fix SC2034: variable appears unused. Verify use (or export if used externally).
* Fix SC2035: Use ./*glob* or -- *glob* so names with dashes won't become options.
* Fix SC2071: > is for string comparisons. Use -gt instead.
* Fix SC2154: variable is referenced but not assigned
* Fix SC2164: Use 'cd ... || exit' or 'cd ... || return' in case cd fails.
* Fix SC2188: This redirection doesn't have a command. Move to its command (or use 'true' as no-op).
* Fix SC2236: Use -n instead of ! -z.
* Fix SC2242: Can only exit with status 0-255. Other data should be written to stdout/stderr.
* Fix SC2086: Double quote to prevent globbing and word splitting.
Co-authored-by: Mehrdad <noreply@github.com>
|
||
|---|---|---|
| .. | ||
| _build | ||
| azure | ||
| dev | ||
| examples | ||
| kubernetes | ||
| site | ||
| source | ||
| tools | ||
| yarn | ||
| .gitignore | ||
| make.bat | ||
| Makefile | ||
| README.md | ||
| requirements-doc.txt | ||
| requirements-rtd.txt | ||
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