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 linked markdown documents #1537

Merged
merged 2 commits into from
Jan 7, 2023

Conversation

abyesilyurt
Copy link
Contributor

Internal markdown links in docs did not work due to a bug in myst-parser. We can use an older version of myst-parser until the bug is fixed.

Example: On page: https://pypdf.readthedocs.io/en/stable/dev/intro.html, link to "See testing pypdf with pytest"

Related issue: executablebooks/MyST-Parser#658

@codecov
Copy link

codecov bot commented Jan 7, 2023

Codecov Report

Base: 91.83% // Head: 91.83% // No change to project coverage 👍

Coverage data is based on head (f9689fa) compared to base (00f1d34).
Patch has no changes to coverable lines.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1537   +/-   ##
=======================================
  Coverage   91.83%   91.83%           
=======================================
  Files          33       33           
  Lines        6073     6073           
  Branches     1193     1193           
=======================================
  Hits         5577     5577           
  Misses        321      321           
  Partials      175      175           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@MartinThoma
Copy link
Member

Thank you for the catch!

However, the way you pinned it is not good. Within the pyproject.toml, only restrictions that are strictly necessary should be done. Otherwise, people might get conflicting dependencies.

Instead of the change in pyproject.toml, please adjust those two:

Internal markdown links in docs does not work due to a bug in myst-parser.
executablebooks/MyST-Parser#658

We can use an older version of myst-parser until the bug is fixed.
@abyesilyurt
Copy link
Contributor Author

Mentioned files are adjusted now.

@MartinThoma MartinThoma merged commit 0ba45ea into py-pdf:main Jan 7, 2023
@MartinThoma
Copy link
Member

Thank you 🤗

MartinThoma added a commit that referenced this pull request Jan 8, 2023
New Features (ENH):
-  Accept hierarchical fields (#1529)

Documentation (DOC):
-  Use google style docstrings (#1534)
-  Fix linked markdown documents (#1537)

Developer Experience (DEV):
-  Update docs config (#1535)

[Full Changelog](3.2.0...3.2.1)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants