Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC: Fix documentation warnings #932

Merged
merged 4 commits into from
Aug 28, 2024
Merged

Commits on Aug 27, 2024

  1. DOC: Fix hyperlink syntax in blog entry

    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
    jhlegarreta committed Aug 27, 2024
    Configuration menu
    Copy the full SHA
    a64cc29 View commit details
    Browse the repository at this point in the history
  2. DOC: Use simple hyperlink syntax to link an internal file

    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 committed Aug 27, 2024
    Configuration menu
    Copy the full SHA
    660e339 View commit details
    Browse the repository at this point in the history
  3. DOC: Fix misplaced column separation character in table

    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.
    jhlegarreta committed Aug 27, 2024
    Configuration menu
    Copy the full SHA
    ab83298 View commit details
    Browse the repository at this point in the history
  4. DOC: Remove a spare whitespace in a table cell

    Remove a spare whitespace in a table cell.i
    jhlegarreta committed Aug 27, 2024
    Configuration menu
    Copy the full SHA
    f035786 View commit details
    Browse the repository at this point in the history