Skip to content

Conversation

@YadavAkhileshh
Copy link

Summary

This PR enables downloadable documentation formats (PDF, HTML zip, ePub) on ReadTheDocs.

Fixes #470

Problem

Users cannot download MuJoCo documentation for offline use. PDF builds were previously disabled due to build failures (see TODO comment in .readthedocs.yml line 6).

Solution

  • Enabled formats in .readthedocs.yml: pdf, htmlzip, epub
  • Configured xelatex engine in doc/conf.py for proper Unicode/math symbol handling
  • Set latex_theme to manual for PDF compatibility (Furo theme is HTML-only)

Changes

  • .readthedocs.yml: Uncommented and configured formats section
  • doc/conf.py: Added LaTeX/PDF build configuration

Testing

  • Verified LaTeX build generates files successfully
  • Configuration syntax validated locally
  • ReadTheDocs will build and verify PDF generation

Benefits

  • Users can download documentation as PDF for offline reading
  • Better accessibility with multiple download formats
  • Matches standard ReadTheDocs documentation features

Fixes google-deepmind#470
- Enable pdf, htmlzip, and epub formats in .readthedocs.yml
- Add xelatex engine for Unicode support in doc/conf.py
- Configure latex_theme for PDF compatibility

Signed-off-by: YadavAkhileshh <[email protected]>
@thowell
Copy link
Contributor

thowell commented Jan 12, 2026

@YadavAkhileshh thank you for this contribution to mujoco!

i think we should be to verify that downloadable formats are available by checking the build for this pr builds/30813332

  • do we know where the links for pdf/htmlzip/epub are located?
  • are all of the changes to conftest.py necessary?

thanks!

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.

Documentation

2 participants