Commit graph

23 commits

Author SHA1 Message Date
Max Pumperla
9b1a3f9f9a
[docs] fix nav (#23417)
Algolia search now does not overflow on mobile devices anymore, making the nav scrollable again.

Signed-off-by: Max Pumperla <max.pumperla@googlemail.com>
2022-03-23 10:38:33 +00:00
Max Pumperla
9482f03134
[docs] RLlib concepts consolidation, user guide, RL conf prep (#22496) 2022-02-18 09:35:20 -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
Sven Mika
e5ead6a4b0
[RLlib; Documentation] Minor fixes "rllib in 60s" and per-feature sigils. (#20248) 2021-11-13 22:10:47 +01:00
Sven Mika
ebd56b57db
[RLlib; documentation] "RLlib in 60sec" overhaul. (#20215) 2021-11-10 22:20:06 +01:00
Kai Fricke
b0bf44b154
[tune/docs] Add high level trial runner flow to documentation (#14468)
* [tune/docs] Add high level trial runner flow to documentation

* Apply suggestions from code review
2021-03-08 10:35:54 +01:00
Sumanth Ratna
e663b524ae
Enable highlighting (#11500) 2020-10-20 09:34:39 -07:00
Sumanth Ratna
40071739dc
[docs] fix version warning banner location (#11286) 2020-10-08 21:21:42 -07:00
Sumanth Ratna
d3fa39efd6
[docs] fix version flyout menu z-index (#10892) 2020-09-19 13:30:35 -07:00
Sumanth Ratna
77c3414bc2
[docs] fix book icon in version flyout menu (#10844)
Co-authored-by: Richard Liaw <rliaw@berkeley.edu>
2020-09-16 19:41:14 -07:00
Richard Liaw
829a2307df
[docs] raise z-index block (#10843)
Co-authored-by: Richard Liaw <rliaw@berkeley.edu>
Co-authored-by: Sumanth Ratna <sumanthratna@gmail.com>
2020-09-16 17:16:50 -07:00
Richard Liaw
edce7a05e6
[docs] fix warning -> tip (#10661)
Co-authored-by: simon-mo <simon.mo@hey.com>
2020-09-08 17:00:09 -07:00
Simon Mo
5a38a76c83
[Doc] Use sphinx_book_theme (#10379) 2020-09-08 16:25:23 -07:00
Richard Liaw
b506f87117
[tune] New Doc edits, add Concepts page (#8083)
Co-Authored-By: Sven Mika <sven@anyscale.io>
2020-04-25 18:25:56 -07:00
Richard Liaw
2cb3355495
[docs] Move css to right location (#8053) 2020-04-16 13:46:50 -07:00
Richard Liaw
d5f517b2f5
[docs] Hotfix for missing css files. (#8051) 2020-04-16 11:44:55 -07:00
Richard Liaw
a67edc4051
[tune] Improve user guides and API docs (#7716)
* create guide gallery for Tune

* mods

* ok

* fix

* fix_up_gallery

* ok

* Apply suggestions from code review

Co-Authored-By: Sven Mika <sven@anyscale.io>

* Apply suggestions from code review

Co-Authored-By: Sven Mika <sven@anyscale.io>

Co-authored-by: Sven Mika <sven@anyscale.io>
2020-04-06 12:16:35 -07:00
Richard Liaw
875309fc48
Revert wide docs (#7782) 2020-03-27 17:46:08 -07:00
Richard Liaw
81d311031b
[tune] Update API Reference Page (#7671)
* widerdocs

* init

* docs

* fix

* moveit

* mix

* better_docs

* remove

* Apply suggestions from code review

Co-Authored-By: Sven Mika <sven@anyscale.io>

Co-authored-by: Sven Mika <sven@anyscale.io>
2020-03-22 16:42:20 -07:00
Richard Liaw
10f21fa313
[docs] Convert Examples to Gallery (#5414) 2019-09-24 15:46:56 -07:00
Robert Nishihara
1a997ed279 Move documentation to ReadTheDocs. (#326) 2017-02-27 21:14:31 -08:00