Skip to content

[docs] Fix readthedocs rendering#7810

Merged
simon-mo merged 8 commits intoray-project:masterfrom
richardliaw:fixdocs
Mar 30, 2020
Merged

[docs] Fix readthedocs rendering#7810
simon-mo merged 8 commits intoray-project:masterfrom
richardliaw:fixdocs

Conversation

@richardliaw
Copy link
Copy Markdown
Contributor

@richardliaw richardliaw commented Mar 30, 2020 •
edited
Loading

Why are these changes needed?

documentation doesn't seem to be built properly (see memory management page).

This introduces a build environment more similar to what's on Readthedocs by adding their requirements.txt env.

We do a hack where we override their sphinx installation - it is not clear if it'll work on their end, but theoretically it should help us render more items on the docs.

Related issue number

Checks

@AmplabJenkins
Copy link
Copy Markdown

AmplabJenkins commented Mar 30, 2020

Test PASSed.
Refer to this link for build results (access rights to CI server needed):
https://amplab.cs.berkeley.edu/jenkins//job/Ray-PRB/23915/
Test PASSed.

@AmplabJenkins
Copy link
Copy Markdown

AmplabJenkins commented Mar 30, 2020

Test PASSed.
Refer to this link for build results (access rights to CI server needed):
https://amplab.cs.berkeley.edu/jenkins//job/Ray-PRB/23916/
Test PASSed.

@AmplabJenkins
Copy link
Copy Markdown

AmplabJenkins commented Mar 30, 2020

Test PASSed.
Refer to this link for build results (access rights to CI server needed):
https://amplab.cs.berkeley.edu/jenkins//job/Ray-PRB/23919/
Test PASSed.

@richardliaw richardliaw changed the title [docs] Fix docs rendering [docs] Fix readthedocs rendering Mar 30, 2020
@AmplabJenkins
Copy link
Copy Markdown

AmplabJenkins commented Mar 30, 2020

Test FAILed.
Refer to this link for build results (access rights to CI server needed):
https://amplab.cs.berkeley.edu/jenkins//job/Ray-PRB/23926/
Test FAILed.

@simon-mo
Copy link
Copy Markdown
Contributor

simon-mo commented Mar 30, 2020

Do you have a successful build with this on another rtd project? e.g. I have a rtd project pointing to my fork https://simon-ray.readthedocs.io/en/latest/

@richardliaw
Copy link
Copy Markdown
Contributor Author

richardliaw commented Mar 30, 2020

ah good suggestion, trying it out.

@richardliaw
Copy link
Copy Markdown
Contributor Author

richardliaw commented Mar 30, 2020

yep lgtm @simon-mo https://rllib.readthedocs.io/en/latest/index.html

simon-mo
simon-mo approved these changes Mar 30, 2020
View reviewed changes
Copy link
Copy Markdown
Contributor

@simon-mo simon-mo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@simon-mo simon-mo merged commit 1832725 into ray-project:master Mar 30, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@simon-mo simon-mo simon-mo approved these changes

Assignees

@simon-mo simon-mo

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@richardliaw @AmplabJenkins @simon-mo