Show import path in the documentation #193
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When reading the documentation for various profiles (e.g.
SuperGaussianTransverseProfile
), the users will also need to know how to import these profiles in theirlasy
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 oflasy.profiles.transverse.super_gaussian_profile.SuperGaussianTransverseProfile
This is how the documentation looks in the development branch:
This is how it looks in this PR: