Refactor documentation and example scripts in README #370
Conversation
This file contains 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
younik
requested changes
Feb 10, 2025
younik
approved these changes
Feb 10, 2025
xela-95
approved these changes
Feb 10, 2025
flferretti
force-pushed
the
update_documentation
branch
from
720b7d2 to
017951b
Compare
flferretti
force-pushed
the
update_documentation
branch
from
017951b to
f258604
Compare
Requires #360 to avoid warnings
Co-authored-by: Alessandro Croci <57228872+xela-95@users.noreply.github.com>
flferretti
force-pushed
the
update_documentation
branch
from
f258604 to
8f65639
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR remove unnecessary width settings in images, format example scripts, and fix syntax errors. Moreover, it updates API documentation to include new sections while removing references to non-existing module and adjusts typing module definitions for clarity.
📚 Documentation preview 📚: https://jaxsim--370.org.readthedocs.build//370/