Skip to content
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

Merged
merged 14 commits into from
Feb 6, 2024
Merged

Update documentation on latest API #79

merged 14 commits into from
Feb 6, 2024

Conversation

flferretti
Copy link
Collaborator

@flferretti flferretti commented Feb 5, 2024

This PR will add installation instructions using conda for jaxsim in README and in the documentation, which was updated according to the latest API.


📚 Documentation preview 📚: https://jaxsim--79.org.readthedocs.build//79/

@flferretti flferretti self-assigned this Feb 5, 2024
@flferretti flferretti changed the title Update README with conda instructions Update documentation on latest API Feb 5, 2024
@flferretti flferretti marked this pull request as ready for review February 5, 2024 16:40
Copy link
Member

@diegoferigo diegoferigo left a 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.

README.md Outdated Show resolved Hide resolved
docs/guide/install.rst Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
docs/index.rst Outdated Show resolved Hide resolved
docs/modules/high_level.rst Outdated Show resolved Hide resolved
src/jaxsim/physics/model/physics_model_state.py Outdated Show resolved Hide resolved
src/jaxsim/simulation/simulator_callbacks.py Outdated Show resolved Hide resolved
src/jaxsim/simulation/simulator_callbacks.py Outdated Show resolved Hide resolved
Comment on lines +23 to +24
if "READTHEDOCS" in os.environ:
_recursive_add_annotations_import()
Copy link
Member

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?

Copy link
Collaborator Author

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

flferretti and others added 6 commits February 6, 2024 09:40
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]>
@flferretti flferretti force-pushed the flferretti-patch-1 branch 3 times, most recently from 3b4f671 to cc6f692 Compare February 6, 2024 10:18
@flferretti flferretti merged commit 9ba607b into main Feb 6, 2024
21 checks passed
@flferretti flferretti deleted the flferretti-patch-1 branch February 6, 2024 13:28
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.

None yet

2 participants