Fix PDF documentation build configuration#5310
Fix PDF documentation build configuration#5310sonu-saini19 wants to merge 1 commit intoMDAnalysis:developfrom
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #5310 +/- ##
========================================
Coverage 93.82% 93.83%
========================================
Files 182 182
Lines 22487 22487
Branches 3196 3196
========================================
+ Hits 21099 21100 +1
+ Misses 925 924 -1
Partials 463 463 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
Hi, welcome. Though, please restore the PR template and answer the sections. While you're at it, please add yourself into the the AUTHORS list and update the CHANGELOG. We will not be reviewing the code changes unless the PR template is restored and filled. Thanks. |
sonu-saini19
left a comment
There was a problem hiding this comment.
Description
Fix dependency configuration for FULL tests.
Changes Made
Adjusted dependency configuration used in FULL test environment.
Related Issue
Fixes #
Checklist
- Tests pass locally
- Code follows project guidelines
|
@sonu-saini19 , you're still missing certain sections. I also just noticed that there are 177 file changes, but the diff basically shows no changes for a majority of them. Would be good to explain why those files are labeled changed (and why they need to be changed in the first place). Is it a Full PR Template: |
Fix dependency list for FULL tests in TestPyPI workflow on macOS with Python 3.13 (Issue MDAnalysis#5281, PR MDAnalysis#5310)
|
@jeremyleung521 Thanks for pointing this out. The large number of changed files is not due to functional modifications. These changes are primarily caused by normalization of line endings (CRLF to LF) and minor formatting adjustments, which made many files appear as modified even though their actual content remains the same. No unintended logic or behavioral changes were introduced in those files. |
|
Fixes #5821 Changes made in this Pull Request:
LLM / AI generated code disclosureLLMs or other AI-powered tools were used in this contribution: yes PR Checklist
Developers Certificate of OriginI certify that I can submit this code contribution as described in the Developer Certificate of Origin, under the MDAnalysis LICENSE |
|
Since you answered 'yes' to the AI section, I'll be closing this, per the AI policy. Next time, I would also suggest not committing unnecessary changes, which clogs up git history. A LF => CR-LF swap is not useful at all ("not [...] functional modifications", as you say) and completely obfuscate what important changes actually are. Looking at the github diff, if I didn't know beforehand that sphinx options are in conf.py, I wouldn't even know what was changed for PDF building (the GitHub UI keeps jumping up and down around the specific file when I scroll)! Also, for future reference, you would want to include the CHANGELOG/author changes directly within in the PR, not pushed directly to your fork. |
This PR fixes the PDF documentation build configuration for the project. The Sphinx documentation setup was updated to ensure that the LaTeX and PDF build process runs successfully without errors.
Changes
Testing
Additional Notes
Some warnings related to deprecated modules or optional dependencies may still appear during the build, but they do not prevent the successful generation of the PDF documentation.
📚 Documentation preview 📚: https://mdanalysis--5310.org.readthedocs.build/en/5310/