DOC: Fix documentation warnings #932
Conversation
jhlegarreta
commented
Aug 27, 2024
•
jhlegarreta
commented
- DOC: Fix hyperlink syntax in blog entry
- DOC: Use simple hyperlink syntax to link an internal file
- DOC: Fix misplaced column separation character in table
- DOC: Remove a spare whitespace in a table cell
jhlegarreta
force-pushed
the
FixDocWarnings
branch
from
ad8f28f
to
4a2fb1a
Compare
|
OK, so 44ce158 is working:
So the above commits uncover some new warnings. I am transferring 44ce158 to another PR so that this can be merged. Other contributors can have a look at the uncovered warnings. Edit: PR #933. |
jhlegarreta
force-pushed
the
FixDocWarnings
branch
from
4a2fb1a
to
698a3bf
Compare
Fix hyperlink syntax in blog entry: add a missing whitespace between the displayed text and the target URL. Fixes: ``` /fury/docs/source/posts/2023/2023-01-29-final-report-shivam.rst:: ERROR: Anonymous hyperlink mismatch: 1 references but 0 targets. See "backrefs" attribute for IDs. ``` raised for example at: https://github.com/fury-gl/fury/actions/runs/10530916380/job/29181869908#step:7:551
Use simple hyperlink syntax to link an intenal file instead of using both the `:doc:` directive and hyperlink syntax. Fixes: ``` /fury/fury/docs/source/posts/2023/2023-07-17-week-7-tvcastillod.rst:19: WARNING: Mismatch: both interpreted text role prefix and reference suffix. ``` raised for example at: https://github.com/fury-gl/fury/actions/runs/10530916380/job/29181869908#step:7:553
jhlegarreta
force-pushed
the
FixDocWarnings
branch
2 times, most recently
from
b012b16
to
2c19312
Compare
There was a problem hiding this comment.
@jhlegarreta LGTM!
It would be preferable to squash the commits into a single commit
jhlegarreta
force-pushed
the
FixDocWarnings
branch
from
2c19312
to
81b51c2
Compare
Fix misplaced column separation character in table: move the column separation `+` character so that it is aligned with the rest of the column separation characters in a blog entry table.
Remove a spare whitespace in a table cell.i
jhlegarreta
force-pushed
the
FixDocWarnings
branch
from
81b51c2
to
f035786
Compare
|
OK, doc build is clean and there are no warnings. PR #933 can be merged right after. @WassCodeur Each commit serves a well-defined purpose, so it is better to leave them separately. |
Algriht. We'll be waiting for @skoudoro now. |
There was a problem hiding this comment.
Thank you @jhlegarreta and thanks for the review @WassCodeur .
LGTM, merging
