Add stubs to python bindings to provide typing information.

[0mdc]

Motivation and Context

This changeset adds stubs to python bindings to provide typing information.
Stub generation depends on pybind11-stubgen.

typing-2024-06-16_22.01.01.mp4

How to test:

• pip install pybind11-stubgen.
• Build habitat-sim normally.
• Import the package in another project, and explore types in your IDE.

WIP:

• Stubs contain some errors, but they mostly work.
• CI is not yet handled.
• Ideally, creating a stub package would scale better, but I could not make it work with bindings. See PEP 561.

How Has This Been Tested

Tested by importing habitat_sim in an external Python file.

Types of changes

• New feature (non-breaking change which adds functionality)

Checklist

• My code follows the code style of this project.
• My change requires a change to the documentation.
• I have updated the documentation accordingly.
• I have read the CONTRIBUTING document.
• I have completed my CLA (see CONTRIBUTING)
• I have added tests to cover my changes.
• All new and existing tests passed.