Docs: fix bugs (broken links, missing examples) #5522
Merged
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
EZoni
commented
Dec 20, 2024
Comment on lines
-25
to
-29
| Here's an example: | ||
|
|
||
| .. literalinclude:: ../../../Examples/Tests/embedded_circle/analysis.py | ||
| :language: python | ||
|
|
There was a problem hiding this comment.
This code example is not relevant since #5456 has been merged (in fact, the file does not exist anymore). This checksum section of the documentation will be refactored soon anyways.
ax3l
pushed a commit
that referenced
this pull request
Jan 8, 2025
Following up on #5387, I think we should also ignore all `.rst` files in the repository when we decide whether or not to run the CI workflows. GitHub Actions syntax taken from the examples [here](https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#patterns-to-match-file-paths) (see `'**.js'` example). Azure syntax to be tested. If we merge this before #5522, we can test it (i.e., test that CI is skipped) in #5522 after rebasing there.
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.
Just fixing a few errors and warnings I found while working on another documentation PR. Mostly broken links and missing examples.
Merge #5523 first, see #5522 (comment) below.