Skip to content

Commit

Permalink
[doc] fix readthedocs build (#46929)
Browse files Browse the repository at this point in the history
The main sidebar without caching version exceeds timed out limit on
readthedocs, but the caching version makes it more complicated for local
build.

Use the cache version of the sidebar for now to unblock. I'm requesting
bigger machines from readthedocs in the mean time, to unify the build
going forward.

Test:
- CI

Signed-off-by: can <can@anyscale.com>
  • Loading branch information
can-anyscale authored Aug 2, 2024
1 parent 30a0eed commit 44f74ba
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 1 deletion.
3 changes: 3 additions & 0 deletions doc/source/_templates/main-sidebar-readthedocs.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
<nav id="main-sidebar" class="bd-docs-nav bd-links" aria-label="{{ _('Section Navigation') }}">
<div class="bd-toc-item navbar-nav">{{ cached_toctree }}</div>
</nav>
6 changes: 5 additions & 1 deletion doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -323,7 +323,11 @@ def render_svg_logo(path):
}

html_sidebars = {
"**": ["main-sidebar"],
"**": [
"main-sidebar-readthedocs"
if os.getenv("READTHEDOCS") == "True"
else "main-sidebar"
],
"ray-overview/examples": [],
}

Expand Down

0 comments on commit 44f74ba

Please sign in to comment.