Doc: Fix RST Syntax #835
Merged
Doc: Fix RST Syntax #835
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ax3l
added
bug
ax3l
commented
Feb 8, 2025
| @@ -7,7 +7,7 @@ In ImpactX, one can easily add new beamline elements as a user. | |||
| There are multiple ways to add new elements to ImpactX, you can pick the one that fits your needs best. | |||
|
|
|||
| The workflows described here apply both for thin kicks or thick elements. | |||
| Thick elements can also use soft-edged fringe fields (see `existing soft-edged elements for implementation details <https://github.com/ECP-WarpX/impactx/tree/development/src/particles/elements>`__). | |||
ax3l
force-pushed
the
fix-rst-parms
branch
2 times, most recently
from
e9b90a5 to
212764b
Compare
Carefully fix RST Syntax in documentation, primarily for the `parameters.rst` file and in particular for nested bullet lists. Also fix other Sphinx warnings on the way.
Makes this long list easier to read, creates a TOC entry for each element, and allow us to link to individual elements.
|
Ah, this makes me happy Preview: https://impactx--835.org.readthedocs.build/en/835/usage/parameters.html#buncher Ready for merge :) |
|
I find the @cemitch99 maybe we could add the paper titles and links to DOIs/JACoW for D. L. Bruhwiler et al., in Proc. of EPAC 98, pp. 1171-1173 (1998) and E. Forest et al., Part. Accel. 45, pp. 65-94 (1994)? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Carefully fix RST Syntax in documentation, primarily for the
parameters.rstfile and in particular for nested bullet lists. Also fix other Sphinx warnings on the way. Improve accessibility (linking to elements, sorting).