Docs: Fix reStructuredText syntax for figures #5386
Merged
Conversation
This file contains hidden or 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
EZoni
added
component: documentation
EZoni
force-pushed
the
docs_figures
branch
2 times, most recently
from
c20b4e7 to
ac671e7
Compare
EZoni
changed the title
reStructuredText syntax for figuresreStructuredText syntax for figures
ax3l
pushed a commit
that referenced
this pull request
Oct 11, 2024
Could we do this to make sure that we run the GitHub Actions and Azure jobs (build, test) only if _at least one file outside the_ `Docs` _directory_ is modified, i.e., skip those jobs if only files in the `Docs` directory are modified? I think it would be safe to do so (and a bit of a waste of resources to not do so...), but I leave it open for discussion. If merged, we could test this rebasing #5386 and seeing if the correct CI jobs are skipped. Note that this PR leaves the other CI jobs untouched, e.g., `source`, `docs`, `CodeQL`, etc.
Member
Author
|
Need to double check if the skipping of CI build/test jobs (#5387) worked out well and if can do more on it. |
EZoni
changed the title
reStructuredText syntax for figuresreStructuredText syntax for figures
EZoni
changed the title
reStructuredText syntax for figuresreStructuredText syntax for figures
EZoni
force-pushed
the
docs_figures
branch
5 times, most recently
from
165de5a to
46e6b0d
Compare
dpgrote
pushed a commit
to dpgrote/WarpX
that referenced
this pull request
Oct 23, 2024
Could we do this to make sure that we run the GitHub Actions and Azure jobs (build, test) only if _at least one file outside the_ `Docs` _directory_ is modified, i.e., skip those jobs if only files in the `Docs` directory are modified? I think it would be safe to do so (and a bit of a waste of resources to not do so...), but I leave it open for discussion. If merged, we could test this rebasing BLAST-WarpX#5386 and seeing if the correct CI jobs are skipped. Note that this PR leaves the other CI jobs untouched, e.g., `source`, `docs`, `CodeQL`, etc.
EZoni
changed the title
reStructuredText syntax for figuresreStructuredText syntax for figures
EZoni
changed the title
reStructuredText syntax for figures
Member
Author
|
Ready for review. |
Member
|
@EZoni sorry about this, but after the documentation changes we merged earlier today, this PR has a couple conflicts. |
Member
Author
|
I think I resolved the conflicts. This should be ready to review again. |
roelof-groenewald
merged commit 5c45760
into
BLAST-WarpX:development
45 of 46 checks passed
dpgrote
pushed a commit
to dpgrote/WarpX
that referenced
this pull request
Nov 5, 2025
While reviewing some of our documentation PRs, I noticed that we use the `:alt:` (alternate text) syntax in a way that might be neither optimal nor consistent with the `reStructuredText` [figure examples](https://docutils.sourceforge.io/docs/ref/rst/directives.html#figure): ```rst .. figure:: picture.png :scale: 50 % :alt: map to buried treasure This is the caption of the figure (a simple paragraph). ``` As a reminder, the `reStructuredText` [image docs](https://docutils.sourceforge.io/docs/ref/rst/directives.html#image) describes alternate text as > Alternate text: a short description of the image, displayed by applications that cannot display images, or spoken by applications for visually impaired users _Before_ this PR, this is the output when an image is displayed:  _Before_ this PR, this is the output when an image is _not_ displayed (e.g., due to a typo in the docs):  _After_ this PR, I would propose to have this output when an image is _not_ displayed (e.g., due to a typo in the docs):  I think this is a better output for both users that read the docs (avoid reading the caption twice) and visually impaired users (avoid hearing the caption twice - the real caption is spoken too). Note that in some cases we do not yet provide a caption. I believe we should add a caption to all figures, but I left this out of this PR.
ax3l
pushed a commit
that referenced
this pull request
Nov 5, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
While reviewing some of our documentation PRs, I noticed that we use the
:alt:(alternate text) syntax in a way that might be neither optimal nor consistent with thereStructuredTextfigure examples:As a reminder, the
reStructuredTextimage docs describes alternate text asBefore this PR, this is the output when an image is displayed:
Before this PR, this is the output when an image is not displayed (e.g., due to a typo in the docs):
After this PR, I would propose to have this output when an image is not displayed (e.g., due to a typo in the docs):
I think this is a better output for both users that read the docs (avoid reading the caption twice) and visually impaired users (avoid hearing the caption twice - the real caption is spoken too).
Note that in some cases we do not yet provide a caption. I believe we should add a caption to all figures, but I left this out of this PR.