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

Links to documentation pages are broken #1569

Closed
MartinThoma opened this issue Jan 22, 2023 · 10 comments
Closed

Links to documentation pages are broken #1569

MartinThoma opened this issue Jan 22, 2023 · 10 comments
Labels
nf-documentation Non-functional change: Documentation

Comments

@MartinThoma
Copy link
Member

If you go to https://pypdf.readthedocs.io/en/latest/user/encryption-decryption.html you can see

Please see the note in the installation guide for installing the extra dependencies if interacting with PDFs that use AES.

at the very top. It should link to installation.html, but it links to installation.md.

This issue was mentioned in #1525 and #1537 attempted to fix it, but broke the doc building process.

Interestingly, I don't have that issue on my local machine

@abyesilyurt
Copy link
Contributor

What is the version of myst_parser on your local?

@MartinThoma
Copy link
Member Author

Ha! Good point 😄 myst-parser==0.16.1

Let me check what exactly was the issue on readthedocs 🕵️

@MartinThoma
Copy link
Member Author

INFO: pip is looking at multiple versions of alabaster to determine which version is compatible with other requirements. This could take a while.
ERROR: Cannot install -r requirements/docs.txt (line 42) and sphinx==5.3.0 because these package versions have conflicting dependencies.

The conflict is caused by:
    The user requested sphinx==5.3.0
    myst-parser 0.16.1 depends on sphinx<5 and >=3.1

To fix this you could try to:
1. loosen the range of package versions you've specified
2. remove package versions to allow pip attempt to solve the dependency conflict

ERROR: ResolutionImpossible: for help visit https://pip.pypa.io/en/latest/topics/dependency-resolution/#dealing-with-dependency-conflicts

@MartinThoma
Copy link
Member Author

Sphinx 5 support was only added with myst-parser==0.18.0. Let's check if we need Sphinx 5 🕵️

@MartinThoma
Copy link
Member Author

I've switched to Sphinx 5 with #1481 , but didn't even mention Sphinx 5.

Looking in the Sphinx Changelog I feel overwhelmed. I just re-built with sphinx 4.5 and couldn't see any issues.

@MartinThoma
Copy link
Member Author

@abyesilyurt Thank you for pointing out this issue again. I need to wait for the build process on readthedocs (about 5 minutes), but I think this time it's fixed.

Sorry for my tone before.

@MartinThoma MartinThoma reopened this Jan 22, 2023
@MartinThoma
Copy link
Member Author

$ make html
Running Sphinx v4.5.0

Exception occurred:
  File "/home/moose/Github/py-pdf/pypdf/venv/lib/python3.7/site-packages/myst_parser/main.py", line 3, in <module>
    import attr
ModuleNotFoundError: No module named 'attr'
The full traceback has been saved in /tmp/sphinx-err-4frt4dqa.log, if you want to report the issue to the developers.
Please also report this if it was a user error, so that a better error message can be provided next time.
A bug report can be filed in the tracker at <https://github.com/sphinx-doc/sphinx/issues>. Thanks!
make: *** [Makefile:20: html] Error 2

@MartinThoma
Copy link
Member Author

After installing attr:

$ make html                           
Running Sphinx v4.5.0

Exception occurred:
  File "/home/moose/Github/py-pdf/pypdf/venv/lib/python3.7/site-packages/myst_parser/main.py", line 4, in <module>
    from attr.validators import (
ModuleNotFoundError: No module named 'attr.validators'; 'attr' is not a package
The full traceback has been saved in /tmp/sphinx-err-cqrud3ir.log, if you want to report the issue to the developers.
Please also report this if it was a user error, so that a better error message can be provided next time.
A bug report can be filed in the tracker at <https://github.com/sphinx-doc/sphinx/issues>. Thanks!
make: *** [Makefile:20: html] Error 2

@MartinThoma
Copy link
Member Author

The import is attr, but I needed https://pypi.org/project/attrs/ 🤦

@MartinThoma
Copy link
Member Author

Finally, it worked 🎉

@MartinThoma MartinThoma added the nf-documentation Non-functional change: Documentation label Mar 25, 2023
MartinThoma added a commit that referenced this issue Mar 27, 2023
myst_parser is pinned to that version as links are otherwise broken,
see #1569

Causing-commit: 0476799
MartinThoma added a commit that referenced this issue Mar 27, 2023
myst_parser is pinned to that version as links are otherwise broken,
see #1569

Causing-commit: 0476799
MartinThoma added a commit that referenced this issue Mar 27, 2023
myst_parser is pinned to that version as links are otherwise broken,
see #1569

Causing-commit: 0476799
MartinThoma added a commit that referenced this issue Mar 27, 2023
myst_parser is pinned to that version as links are otherwise broken,
see #1569

Causing-commit: 0476799
MartinThoma added a commit that referenced this issue Mar 27, 2023
myst_parser is pinned to that version as links are otherwise broken,
see #1569

Causing-commit: 0476799
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

No branches or pull requests

2 participants