Commit graph

39 commits

Author SHA1 Message Date
Max Pumperla
29d94a2211
[docs] sphinx gallery removal, migrate to ipynb (#22467) 2022-02-19 01:19:07 -08:00
Guyang Song
9f77090c1c
[Doc] Fix bad links of dask and mars in ray-libraries.rst (#22210) 2022-02-08 19:02:49 +08:00
Max Pumperla
4dd221f848
[Docs] Ray Data docs target state (#21931)
Preview: [docs](https://ray--21931.org.readthedocs.build/en/21931/data/dataset.html)

The Ray Data project's docs now have a clearer structure and have partly been rewritten/modified. In particular we have

- [x] A Getting Started Guide
- [x] An explicit User / How-To Guide
- [x] A dedicated Key Concepts page
- [x] A consistent naming convention in `Ray Data` whenever is is referred to the project.

This surfaces quite clearly that, apart from the "Getting Started" sections, we really only have one real example. Once we have more, we can create an "Example" section like many other sub-projects have. This will be addressed in https://github.com/ray-project/ray/issues/21838.
2022-01-27 13:14:36 -08:00
Max Pumperla
b34099e764
[docs] landing page (fixes #21750) (#21859)
Co-authored-by: Richard Liaw <rliaw@berkeley.edu>
2022-01-26 17:14:25 -08:00
Max Pumperla
7953c9ca57
[docs] integrate algolia docsearch, move to sphinx panels (#21814) 2022-01-24 17:00:41 -08: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
Sven Mika
7a585fb275
[RLlib; Documentation] RLlib README overhaul. (#20249) 2021-11-18 18:08:40 +01:00
matthewdeng
e77cc926be
[train] minor doc updates (#20271) 2021-11-12 17:20:23 -08:00
Philipp Moritz
0a5942d8b0
[Documentation] Fix quotes for windows installations (#19859)
* [Documentation] Fix quotes for windows installations

* update

* formatting
2021-10-29 10:54:38 -07:00
Eric Liang
430a5f4a21
[doc] Bump dataset to beta for 1.8 and add backlink to SGD (#19332) 2021-10-12 18:32:29 -07:00
Eric Liang
d1f348cd9d
[RFC] Split the list of libraries into ML vs production 2021-09-14 16:32:07 -07:00
Eric Liang
cbdafa0b63
[doc] Fix various workflow doc bugs (#18357) 2021-09-06 01:39:08 -07:00
Tim Hopper
fd2a8a6b9c
[docs] Fix broken urls (#18206) 2021-08-30 17:24:06 -07:00
Eric Liang
95b5ad12ba
Initial version of workflow documentation (#18138) 2021-08-27 16:20:48 -07:00
Eric Liang
26a286655b
Add link to datasets preview docs 2021-07-16 12:31:52 -07:00
Eric Squires
9f70293700
Remove debug extras from setup.py (#12751) 2020-12-10 16:23:11 -06:00
Robert Nishihara
d681991773
Add Discourse to readme and make it more prominent in docs. (#12740) 2020-12-10 01:13:40 -08:00
Richard Liaw
751e13a41e
[docs] redirect to discourse (#12427) 2020-11-25 17:10:10 -08:00
Max Fan
c816a44667
[docs] Insert missing article in sentence (#12245) 2020-11-23 12:53:11 -08:00
Richard Liaw
7d1015d23e
[Doc] Fix Core Link (#11438)
Signed-off-by: Richard Liaw <rliaw@berkeley.edu>
2020-10-16 10:10:56 -07:00
Richard Liaw
a563344bc2
[docs] remove ref to google groups -> github discussions (#11019) 2020-09-24 18:09:51 -07:00
Richard Liaw
41d7221dcd
fix (#10876) 2020-09-17 23:17:39 -07:00
Eric Liang
72b28dc12b
[docs] Fix broken links in new community libraries page ++ (#10785)
* fix

* fix up

* update

* revert

* typo

* update
2020-09-14 21:18:28 -07:00
Eric Liang
daabe6bb1f
[docs] Polish community integrations docs (#10780) 2020-09-14 14:41:06 -07:00
Richard Liaw
020a105476
[docs] init list of oss projects (#10758) 2020-09-14 12:11:05 -07:00
Hao Chen
f7558ed2a5
Remove outdated Java doc and run demo code in CI (#10698) 2020-09-11 19:15:52 +08:00
Simon Mo
5a38a76c83
[Doc] Use sphinx_book_theme (#10379) 2020-09-08 16:25:23 -07:00
Hao Chen
f9098fe631
[Java doc] index and introduction page (#10646) 2020-09-08 22:00:46 +08:00
Eric Liang
30911960c8
[1.0] Simple, universal instead of Simple and universal (#10587) 2020-09-04 14:04:29 -07:00
Eric Liang
e5d089384b
[1.0] Ray whitepaper link and tagline update (#10455) 2020-09-01 09:48:35 -07:00
Stephanie Wang
9c2c952262
Add documentation for Dask-on-Ray (#10452)
* Dask on ray

* Dask on ray

* line

* Add links
2020-09-01 08:13:04 -07:00
Bill Chambers
067c2752f8
[TUNE] Tune Docs re-organization (#9600)
Co-authored-by: Richard Liaw <rliaw@berkeley.edu>
2020-07-29 11:22:44 -07:00
Richard Liaw
7abf7a0109
[docs] Render ActorPool documentation, etc (#9433) 2020-07-13 17:59:22 -07:00
Hao Chen
d49dadf891
Change Python's ObjectID to ObjectRef (#9353) 2020-07-10 17:49:04 +08:00
Richard Liaw
56d934bc18
[docs] Revised Cluster documentation (#9062)
Co-authored-by: Edward Oakes <ed.nmi.oakes@gmail.com>
2020-06-26 09:29:22 -07:00
Richard Liaw
75e6775b36
[docs] Make Contributions/Building pages more prominent (#9054)
Co-authored-by: Edward Oakes <ed.nmi.oakes@gmail.com>
2020-06-25 12:38:12 -07:00
Bill Chambers
b3d686b78f
[docs] Add Overview Section & Gentle Introduction (#8517) 2020-05-26 10:39:34 -05:00