Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Doc] Optimize build time #11

Conversation

peytondmurray
Copy link
Owner

Why are these changes needed?

This PR optimizes the build time of the docs-build-system-upgrade branch.

It does this by generating the sidebar HTML once (per worker) and then reusing it on every page, bypassing pydata-sphinx-theme's sidebar construction machinery. To maintain the collapsed/expanded state of the sidebar dropdown items, we use the browser's local storage, which is restored on each page load.

  • Moves the custom directives in conf.py into custom_directives.py at the request of @maxpumperla
  • Removes reference to document that doesn't exist
  • Add make show command, which used http.server to serve docs built locally
  • Removes code for making "galleries", which we aren't using in the new docs build system

Related issue number

Partially addresses ray-project#37944.

Checks

  • I've signed off every commit(by using the -s flag, i.e., git commit -s) in this PR.
  • I've run scripts/format.sh to lint the changes in this PR.
  • I've included any doc changes needed for https://docs.ray.io/en/master/.
    • I've added any new APIs to the API Reference. For example, if I added a
      method in Tune, I've added it in doc/source/tune/api/ under the
      corresponding .rst file.
  • I've made sure the tests are passing. Note that there might be a few flaky tests, see the recent failures at https://flakey-tests.ray.io/
  • Testing Strategy
    • Unit tests
    • Release tests
    • This PR is not tested :(

Signed-off-by: pdmurray <peynmurray@gmail.com>
@peytondmurray peytondmurray force-pushed the docs-build-system-upgrade-optimize-build branch from b7e758b to 0897850 Compare November 17, 2023 18:37
@peytondmurray peytondmurray merged commit c9f3ff7 into docs-build-system-upgrade Nov 17, 2023
1 check passed
@peytondmurray peytondmurray deleted the docs-build-system-upgrade-optimize-build branch November 17, 2023 18:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant