Skip to content

Broken cross-reference links in docs #1492

Closed
@MasterOdin

Description

@MasterOdin

The following two cross-ref links are broken in the docs, where on viewing the page on RTD, it's just shown as normal text:

https://github.com/py-pdf/PyPDF2/blob/74b8a6364ee806cc0510b024864502d1fdbd8204/docs/user/extract-text.md?plain=1#L23

https://pypdf2.readthedocs.io/en/latest/user/extract-text.html

https://github.com/py-pdf/PyPDF2/blob/74b8a6364ee806cc0510b024864502d1fdbd8204/docs/user/merging-pdfs.md?plain=1#L53

https://pypdf2.readthedocs.io/en/latest/user/merging-pdfs.html

From the sphinx build log:

/Users/mpeveler/code/github/PyPDF2/docs/user/extract-text.md:23: WARNING: 'myst' reference target not found: ../modules/PageObject.html#PyPDF2._page.PageObject.extract_text
/Users/mpeveler/code/github/PyPDF2/docs/user/merging-pdfs.md:53: WARNING: 'myst' reference target not found: ../modules/PdfWriter.html#PyPDF2.PdfWriter.append

While modifying the link down to ../modules/PageObject.md works for the first link, I couldn't find a way to get the anchor to be recognized. The cropping-and-transforming.md page works around this by using a full link:

https://github.com/py-pdf/PyPDF2/blob/74b8a6364ee806cc0510b024864502d1fdbd8204/docs/user/cropping-and-transforming.md?plain=1#L37

but this breaks the user workflow where if they were viewing the non-latest version of the docs, this would bring them to the latest.

Metadata

Metadata

Assignees

No one assigned

    Labels

    nf-documentationNon-functional change: Documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions