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.

Sign up for GitHub

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

Fix cross-references to classes in Sphinx doc #195

Merged
merged 2 commits into from
Oct 20, 2023
Merged

Fix cross-references to classes in Sphinx doc #195

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a089de6
Fix cross-references to classes in Sphinx doc
RemiLehe Oct 18, 2023
6b47a98
Apply suggestions from code review
RemiLehe Oct 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions lasy/profiles/combined_profile.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,11 +37,11 @@ class CombinedLongitudinalTransverseProfile(Profile):
field (:math:`E_0` in the above formula) is automatically
calculated so that the pulse has the prescribed energy.

long_profile : an instance of `lasy`'s :class:LongitudinalProfile
long_profile : :class:`.LongitudinalProfile`
Defines the longitudinal envelope of the laser, i.e. the
function :math:`\mathcal{L}(t)` in the above formula.

transverse_profile : an instance of `lasy`'s :class:TransverseProfile
transverse_profile : :class:`.TransverseProfile`
Defines the transverse envelope of the laser, i.e. the
function :math:`\mathcal{T}(x, y)` in the above formula.
"""
Expand Down
2 changes: 1 addition & 1 deletion lasy/profiles/longitudinal/gaussian_profile.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ class GaussianLongitudinalProfile(LongitudinalProfile):
Derived class for the analytic profile of a longitudinally-Gaussian laser pulse.

More precisely, the longitudinal envelope
(to be used in the :class:CombinedLongitudinalTransverseProfile class)
(to be used in the :class:`.CombinedLongitudinalTransverseProfile` class)
corresponds to:

.. math::
Expand Down
2 changes: 1 addition & 1 deletion lasy/profiles/transverse/gaussian_profile.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ class GaussianTransverseProfile(TransverseProfile):
Derived class for the analytic profile of a Gaussian laser pulse.

More precisely, at focus (``z_foc=0``), the transverse envelope
(to be used in the :class:CombinedLongitudinalTransverseLaser class)
(to be used in the :class:`.CombinedLongitudinalTransverseLaser` class)
corresponds to:

.. math::
Expand Down
2 changes: 1 addition & 1 deletion lasy/profiles/transverse/hermite_gaussian_profile.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ class HermiteGaussianTransverseProfile(TransverseProfile):

Derived class for an analytic profile.
More precisely, the transverse envelope (to be used in the
:class:CombinedLongitudinalTransverseLaser class) corresponds to:
:class:`.CombinedLongitudinalTransverseLaser` class) corresponds to:

.. math::

Expand Down
2 changes: 1 addition & 1 deletion lasy/profiles/transverse/laguerre_gaussian_profile.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ class LaguerreGaussianTransverseProfile(TransverseProfile):

Derived class for an analytic profile.
More precisely, at focus (`z_foc=0`), the transverse envelope (to be used in the
:class:CombinedLongitudinalTransverseLaser class) corresponds to:
:class:`.CombinedLongitudinalTransverseLaser` class) corresponds to:

.. math::

Expand Down
Loading