Skip to content

Conversation

@skye
Copy link
Member

@skye skye commented Apr 15, 2025

Also some minor formatting changes

@skye skye requested a review from ZacCranko April 15, 2025 15:44
@skye
Copy link
Member Author

skye commented Apr 15, 2025

Dumb q: how do I look at the rendered RTD docs? The action has link https://app.readthedocs.org/dashboard/jax/version/28034/edit/ which is 404 for me

@google-ml-butler google-ml-butler bot added kokoro:force-run pull ready Ready for copybara import and testing labels Apr 15, 2025
@ZacCranko
Copy link
Collaborator

Dumb q: how do I look at the rendered RTD docs? The action has link https://app.readthedocs.org/dashboard/jax/version/28034/edit/ which is 404 for me

some more info here about the deps you need here, but the command you want is

sphinx-build -E -v -b html -D nb_execution_mode=off -j auto docs docs/build/html docs/config_options.rst

Copy link
Collaborator

@ZacCranko ZacCranko left a comment

Choose a reason for hiding this comment

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

Ooops looks like there's a build error now

/__w/jax/jax/docs/config_options.rst:57: WARNING: Bullet list ends without a blank line; unexpected unindent.

@yashk2810
Copy link
Collaborator

how do I look at the rendered RTD docs?

On the PR, you need to add the documentation label for the job to trigger. This was a recent change. For local, do what Zac said!

@ZacCranko
Copy link
Collaborator

Docs build looks good, ship it!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation kokoro:force-run pull ready Ready for copybara import and testing

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants