Store black configuration in pyproject.toml and enhance pyright support

[diegoferigo-rai]

Description

This PR updates the pyproject.toml configuration to improve compatibility with tooling such as black and pyright. The changes affect both standalone usage of these tools and their integration when invoked from IDEs like VSCode.

This allows users who are not interested in autogenerating the settings.json file to have their IDEs configured out of the box.

This approach could be also extended to other tools like flake, pylint, etc.

Note

This PR targets feature/newton, which is the branch I'm currently interested. It can be backported to main if needed.

Type of change

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

Checklist

• I have read and understood the contribution guidelines
• I have run the pre-commit checks with ./isaaclab.sh --format
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• I have added tests that prove my fix is effective or that my feature works
• I have updated the changelog and the corresponding version in the extension's config/extension.toml file
• I have added my name to the CONTRIBUTORS.md or my name already exists there

[Mayankm96]

@ClemensSchwarke Following up here with our discussion to switch to ruff entirely :)

[diegoferigo-rai]

@ClemensSchwarke Following up here with our discussion to switch to ruff entirely :)

I'd be super happy about a ruff migration. Let me know what works best for you. I can update this PR to introduce a ruff configuration compatible with black and isort, or close this and wait for your upcoming PRs.

[ClemensSchwarke]

Hey @diegoferigo-rai, I think it would be super nice if you could add the ruff configuration for the parts you are interested in. I can take care of the remaining integration.