Improve Python bindings build-from-source documentation #3033
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Add tip explaining which steps to repeat when modifying C/C++ code - Clarify step 3 with two clear options (download vs build from source) - Use `export` for environment variables for clarity - Explain why MUJOCO_PLUGIN_PATH is required - Add concrete examples for Linux and macOS Closes google-deepmind#1708
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Improves the build-from-source documentation for Python bindings to address common user questions.
Closes #1708
Changes
exportfor environment variables for better shell compatibilityMUJOCO_PLUGIN_PATHis required even without pluginsMotivation
Users building from source were confused about:
MUJOCO_PLUGIN_PATHwas needed