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: add readthedocs.yml and bump docs dependencies using tox -e deps #1750

Merged
merged 1 commit into from
Mar 27, 2023

Conversation

adehad
Copy link
Contributor

@adehad adehad commented Mar 26, 2023

Follow up to #1430

Add the readthedocs config.

Hoping that adding the editable install inside the docs.txt is fine. I have an alternative option if it doesn't work.

@codecov
Copy link

codecov bot commented Mar 27, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (050bca6) 92.41% compared to head (eff93f5) 92.41%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1750   +/-   ##
=======================================
  Coverage   92.41%   92.41%           
=======================================
  Files          34       34           
  Lines        6575     6575           
  Branches     1301     1301           
=======================================
  Hits         6076     6076           
  Misses        326      326           
  Partials      173      173           

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 in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@MartinThoma
Copy link
Member

We did have issues with links in the past: #1569

For that reason, we pinned myst-parser: 6abb50e

Let's see if they are gone

@MartinThoma MartinThoma merged commit 0476799 into py-pdf:main Mar 27, 2023
@MartinThoma
Copy link
Member

I'm uncertain if the readthedocs.yml is used at all. At least I don't see it being mentioned in the build logs.

@MartinThoma
Copy link
Member

#1569 is back. I revert the changes to the requirement files.

@MartinThoma
Copy link
Member

I fixed it via #1752 :-)

Thank you for your PR. Nudging me to use configuration files within the repository + enabling "build pull requests" is a good idea 👍

If you want, I can add you to https://pypdf.readthedocs.io/en/latest/meta/CONTRIBUTORS.html :-)

@MartinThoma
Copy link
Member

I cannot figure out how to make GitHub/Readthedocs add a message within the PR with a link to the built docs

The build docs are at https://readthedocs.org/projects/pypdf/builds/

@adehad
Copy link
Contributor Author

adehad commented Mar 27, 2023

It is normally added in the "Checks" for a PR, I think you can try it on my other PR (ie closing and opening the PR should re trigger the builds)

@adehad
Copy link
Contributor Author

adehad commented Mar 28, 2023

@MartinThoma it seems it didn't add to the other PR
I had a look at
https://docs.readthedocs.io/en/latest/guides/pull-requests.html

And it suggested that the integration needs OAuth access granted/checked. So might be worth double checking that too.

Sorry for the confusion

@adehad
Copy link
Contributor Author

adehad commented Mar 28, 2023

(I can at least confirm that the PR docs are public, as I can access https://pypdf--1752.org.readthedocs.build/en/1752/)

MartinThoma added a commit that referenced this pull request Apr 9, 2023
Security (SEC):
-  Warn about PDF encryption security (#1755)

Robustness (ROB):
-  Prevent loop in Cloning (#1770)
-  Capture UnicodeDecodeError at PdfReader.pdf_header (#1768)

Documentation (DOC):
-  Pin myst_parser==0.16.1 and rename .readthedocs.yaml (#1752)
-  Add readthedocs.yml and bump docs dependencies using `tox -e deps` (#1750)

Developer Experience (DEV):
-  Make make_changelog.py idempotent

Maintenance (MAINT):
-  Move generation of file identifiers to a method (#1760)

Testing (TST):
-  Add xmp test (#1775)

Code Style (STY):
-  Improve language, add docstrings, fix TODOs (#1772)
-  Test names, docstrings, and parametrization (#1771)

[Full Changelog](3.7.0...3.7.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