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

Broken cross-reference links in docs #1492

Closed
MasterOdin opened this issue Dec 11, 2022 · 0 comments · Fixed by #1506
Closed

Broken cross-reference links in docs #1492

MasterOdin opened this issue Dec 11, 2022 · 0 comments · Fixed by #1506
Labels
nf-documentation Non-functional change: Documentation

Comments

@MasterOdin
Copy link
Member

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
nf-documentation Non-functional change: Documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants