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

Show import path in the documentation #193

Merged
merged 2 commits into from
Oct 19, 2023

Conversation

RemiLehe
Copy link
Member

@RemiLehe RemiLehe commented Oct 18, 2023

When reading the documentation for various profiles (e.g. SuperGaussianTransverseProfile), the users will also need to know how to import these profiles in their lasy script.

This PR makes sure that the Sphinx documentation does show the import path. I also used the shorter path that is available for a number of classes (e.g. lasy.profiles.transverse.SuperGaussianTransverseProfile instead of lasy.profiles.transverse.super_gaussian_profile.SuperGaussianTransverseProfile

This is how the documentation looks in the development branch:

Screenshot 2023-10-18 at 4 00 09 PM

This is how it looks in this PR:

Screenshot 2023-10-18 at 4 00 33 PM

@RemiLehe RemiLehe requested a review from AngelFP October 18, 2023 23:11
@AngelFP AngelFP added the documentation Improvements or additions to documentation label Oct 19, 2023
Copy link
Member

@AngelFP AngelFP 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 for taking care of using the shorter paths.

@RemiLehe RemiLehe merged commit 8c81ad4 into LASY-org:development Oct 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants