[docs] sphinx design 1/n #34625
Merged
[docs] sphinx design 1/n #34625
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Max Pumperla <[email protected]>
Signed-off-by: Max Pumperla <[email protected]>
Signed-off-by: Max Pumperla <[email protected]>
Signed-off-by: Max Pumperla <[email protected]>
Signed-off-by: Max Pumperla <[email protected]>
maxpumperla
requested review from
richardliaw,
gjoliver,
krfricke,
xwjiang2010,
amogkam,
matthewdeng,
Yard1,
a team,
ericl,
scv119,
c21,
scottjlee and
bveeramani
as code owners
Signed-off-by: Max Pumperla <[email protected]>
maxpumperla
commented
Apr 21, 2023
| @@ -308,7 +308,7 @@ build_sphinx_docs() { | |||
| if [ "${OSTYPE}" = msys ]; then | |||
| echo "WARNING: Documentation not built on Windows due to currently-unresolved issues" | |||
| else | |||
| FAST=True make html | |||
| FAST=True make develop | |||
There was a problem hiding this comment.
this is slightly risky, will revert this after N/N for this migration. the two plugins in question currently clash and throw a warning. Note that this only suppresses warnings, not errors.
Signed-off-by: Max Pumperla <[email protected]>
|
doctest and linkcheck failures are unrelated |
richardliaw
approved these changes
Apr 21, 2023
elliottower
pushed a commit
to elliottower/ray
that referenced
this pull request
Apr 22, 2023
Signed-off-by: elliottower <[email protected]>
ProjectsByJackHe
pushed a commit
to ProjectsByJackHe/ray
that referenced
this pull request
May 4, 2023
Signed-off-by: Jack He <[email protected]>
architkulkarni
pushed a commit
to architkulkarni/ray
that referenced
this pull request
May 16, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
First PR of many to replace the old and unmaintained
spinx-panelsby the newer plugin with LTS (by the same authors) calledsphinx-design. Slightly different syntax, but same functionality. Stylistically slightly different, but more powerful later on. We need to take care of 3 things (the latter 2 always go together):tabbedby eithertabsortab-setlink-buttonbybutton-refandbutton-linkpanelsbygridImportant: once fully removing
sphinx-panelsfrom dependencies, we can finally upgrade our theme and the base sphinx version to.