Commit graph

13 commits

Author SHA1 Message Date
clarng
b404175635
Add tip to first uninstall the Python-only build before installing the Full build (#25754)
Adds the following to install instructions:

Tip

If you are only editing Python files, follow instructions for Building Ray (Python Only) to avoid long build times.

If you already followed the instructions in Building Ray (Python Only) and want to switch to the Full build in this section, you will need to first delete the symlinks and uninstall Ray.
2022-08-06 21:38:13 -07:00
Jiao
bf1d9971f1
[setup-dev] Add flag to skip symlink certain folders (#26899) 2022-07-25 10:21:20 -07:00
Alex Wu
146f65ba7a
[docs] Update docs for building from source (#26045)
The existing docs didn't work for me and these updates did. 🤷‍♀️ I selectively pulled this stuff out of the CI (which ideally would just be runnable locally).
2022-07-06 12:17:05 -07:00
matthewdeng
68315b34b4
[docs] move troubleshooting section to source development page (#26166) 2022-06-28 16:06:46 -07:00
Qing Wang
8c385cff11
[doc] Fix the document on how to build java from source. (#25351) 2022-06-02 12:39:54 +08:00
Simon Mo
c3ac6fcf3f
Bump Ray Version from 2.0.0.dev0 to 3.0.0.dev0 (#24894) 2022-05-17 19:31:05 -07:00
Sebastián Ramírez
2842b074bb
📝 Update structure in development docs (#24377)
This is a small update for the structure of the docs about building Ray from source.

My idea was to isolate steps that are shared and then steps required per platform/system. Also consolidating the instructions to clone with git, install, directory structure, etc.

I'm still figuring out the building steps (installing the dependencies for docs in an M1), but I wanted to start the draft right away.
2022-05-11 15:47:54 -05:00
Kai Fricke
65d9a410f7
[ci] Clean up ci/ directory (refactor ci/travis) (#23866)
Clean up the ci/ directory. This means getting rid of the travis/ path completely and moving the files into sensible subdirectories.

Details:

- Moves everything under ci/travis into subdirectories, e.g. ci/build, ci/lint, etc.
- Minor adjustments to some scripts (variable renames)
- Removes the outdated (unused) asan tests
2022-04-13 18:11:30 +01:00
mwtian
51feac9868
Clean up dev docs (#23407) 2022-03-22 23:22:56 -07:00
Max Pumperla
d8e862eaba
[docs] templates and contribution guide (fixes #21753) (#23003)
Adding an explicit contributor guide and example templates for our users to help with docs.

Signed-off-by: Max Pumperla <max.pumperla@googlemail.com>
2022-03-10 15:28:07 +00:00
Max Pumperla
f9b71a8bf6
[docs] new structure (#21776)
This PR consolidates both #21667 and #21759 (look there for features), but improves on them in the following way:

- [x] we reverted renaming of existing projects `tune`, `rllib`, `train`, `cluster`, `serve`, `raysgd` and `data` so that links won't break. I think my consolidation efforts with the `ray-` prefix were a little overeager in that regard. It's better like this. Only the creation of `ray-core` was a necessity, and some files moved into the `rllib` folder, so that should be relatively benign.
- [x] Additionally, we added Algolia `docsearch`, screenshot below. This is _much_ better than our current search. Caveat: there's a sphinx dependency that needs to be replaced (`sphinx-tabs`) by another, newer one (`sphinx-panels`), as the former prevents loading of the `algolia.js` library. Will follow-up in the next PR (hoping this one doesn't get re-re-re-re-reverted).
2022-01-21 15:42:05 -08:00
xwjiang2010
9af8f11191
Revert "[docs] Clean up doc structure (first part) (#21667)" (#21763)
This reverts commit 38e46c9fb3.
2022-01-20 15:30:56 -08:00
Max Pumperla
38e46c9fb3
[docs] Clean up doc structure (first part) (#21667) 2022-01-20 16:19:04 +01:00
Renamed from doc/source/development.rst (Browse further)