-
Notifications
You must be signed in to change notification settings - Fork 9
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update documentation on latest API #79
Conversation
89b0398
to
fccfe2c
Compare
conda
instructionsfccfe2c
to
58aeb1c
Compare
6d7a4fe
to
95bcaa5
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good, thanks! Just minor suggestions and curiosities.
if "READTHEDOCS" in os.environ: | ||
_recursive_add_annotations_import() |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do you have any reference for the need of this logic?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You may have a look at the PEP 563 on postponed type evaluation. The aim here is to re-evaluate the types defined in the typing module so that they appear correctly in the documentation
Co-authored-by: Diego Ferigo <[email protected]>
Co-authored-by: Diego Ferigo <[email protected]>
Co-authored-by: Diego Ferigo <[email protected]>
Co-authored-by: Diego Ferigo <[email protected]>
Co-authored-by: Diego Ferigo <[email protected]>
Co-authored-by: Diego Ferigo <[email protected]>
3b4f671
to
cc6f692
Compare
Co-authored-by: Diego Ferigo <[email protected]>
cc6f692
to
9531b49
Compare
This PR will add installation instructions using
conda
forjaxsim
in README and in the documentation, which was updated according to the latest API.📚 Documentation preview 📚: https://jaxsim--79.org.readthedocs.build//79/