google-deepmind
Enable pdf download for the online documentation
The feature, motivation and pitch
The online documentation for mujoco does not have a pdf download option available. Please make it available.
Alternatives
No response
Additional context
No response
Hi @zevla, This sounds like a useful enhancement! I'd love to help implement a PDF download option for the online documentation. Could you please guide me to the relevant repo or documentation source (e.g., Sphinx, MkDocs, or any custom setup)? I’ll be happy to work on this and raise a PR.
Thanks!
@YashSachdeva I have looked into the mujoco repo. The documentation is built on sphinx and readthedocs.
After searching both sphinx and readthedocs docs, I think to enable pdf/epub formats you need to edit the file mujoco/.readthedocs.yml . Check out this link on configuration file reference to see which part to edit. See the first code block on sphinx from line 25 to 28.
You can also see this link on how to enable offline formats.
Also, this link on offline formats and flyout menu might be useful.
I have checked the sphinx documentation but haven't found anything significant related to enabling pdf download options. They redirect to readthedocs documentations ultimately.
We weren't able to get this working... maybe you can figure it out?
cc @thowell
