docs: Fix basic rst formatting errors #2958
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
|
The remaining 20 issues causing "problematic" are in the following files:
|
|
This PR causes the following changes to the html docs (ubuntu-latest-3.11): See CI logs for the full diff. |
|
The HTML documentation with the fixes is available at [0] [0] https://jvesely.github.io/PsyNeuLink/branch/docs/ |
Fixes 3 instances of: WARNING: Malformed table. Signed-off-by: Jan Vesely <[email protected]>
Fixes 13 instances of: WARNING: Title underline too short. Signed-off-by: Jan Vesely <[email protected]>
Fixes 31 instances of: WARNING: Inline strong start-string without end-string. There are 6 remaining instances that all come from: psyneulink.core.scheduling.condition imported from graph_scheduler Signed-off-by: Jan Vesely <[email protected]>
Fixes one instance of: WARNING: Inline literal start-string without end-string. Signed-off-by: Jan Vesely <[email protected]>
Fixes two instances of: WARNING: Inline emphasis start-string without end-string. The remaining instances are imported from schedulin.condition. Signed-off-by: Jan Vesely <[email protected]>
Fixes 3 instances of: WARNING: Unknown target name: Signed-off-by: Jan Vesely <[email protected]>
Fixes 31 instances of: WARNING: Inline interpreted text or phrase reference start-string without end-string. Signed-off-by: Jan Vesely <[email protected]>
Fixes one instance of: WARNING: Inline substitution_reference start-string without end-string. Signed-off-by: Jan Vesely <[email protected]>
|
This PR causes the following changes to the html docs (ubuntu-latest-3.11): See CI logs for the full diff. |
kmantel
approved these changes
May 1, 2024
Thank you. I didn't find a way to selectively turn some warnings into errors to prevent reintroducing them later. The current warnings count is: |
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.
Fix the following warnings:
WARNING: Malformed table. (3 instances)
WARNING: Title underline too short. (13 instances)
WARNING: Inline strong start-string without end-string. (31 instances)
WARNING: Inline literal start-string without end-string. (1 instance)
WARNING: Inline emphasis start-string without end-string. (2 instances)
WARNING: Unknown target name (3 instances)
WARNING: Inline interpreted text or phrase reference start-string without end-string. (31 instances)
WARNING: Inline substitution_reference start-string without end-string. (1 instance)
The above removes 61/81 instances of
<span class="problematic">in the generated html.