Skip to content

Fix PDF documentation build configuration#5310

Open
sonu-saini19 wants to merge 1 commit intoMDAnalysis:developfrom
sonu-saini19:fix-pdf-doc-build
Open

Fix PDF documentation build configuration#5310
sonu-saini19 wants to merge 1 commit intoMDAnalysis:developfrom
sonu-saini19:fix-pdf-doc-build

Conversation

@sonu-saini19
Copy link

@sonu-saini19 sonu-saini19 commented Mar 14, 2026

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

  • Updated the Sphinx configuration to support proper PDF generation.
  • Fixed documentation structure issues related to the Sphinx source directory.
  • Resolved LaTeX build configuration problems.
  • Ensured that the documentation build process completes successfully.

Testing

  • Ran the documentation build locally using the Sphinx build command.
  • Verified that the LaTeX files are generated correctly.
  • Confirmed that the PDF documentation build completes without blocking errors.

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/

@codecov
Copy link

codecov bot commented Mar 14, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 93.83%. Comparing base (50dc512) to head (40b912c).

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@jeremyleung521
Copy link
Contributor

jeremyleung521 commented Mar 16, 2026

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.

@jeremyleung521 jeremyleung521 added the more information needed Please reply to requests for information or the issue will be closed. label Mar 16, 2026
Copy link
Author

@sonu-saini19 sonu-saini19 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@jeremyleung521
Copy link
Contributor

jeremyleung521 commented Mar 16, 2026

@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 black formatting thing or a dos2unix thing?

Full PR Template:

<!-- 
Insert issue number that this PR fixes (if any) just after 'Fixes #'.
If this PR does not fix an existing issue, consider opening one or remove 'Fixes #' from the PR description.
-->
Fixes #

Changes made in this Pull Request:
<!-- Describe the changes that this PR makes. If applicable, use the following bullet list. --> 
-

## LLM / AI generated code disclosure
<!-- Please update this disclosure to reflect if you did or did not use LLMs / AI to generate code -->
LLMs or other AI-powered tools (beyond simple IDE use cases) were used in this contribution: yes / no

## PR Checklist
<!-- Please use the following checklist to ensure the PR is ready to be reviewed/merged. -->
 - [ ] Issue raised/referenced?
 - [ ] Tests updated/added?
 - [ ] Documentation updated/added?
 - [ ] `package/CHANGELOG` file updated?
 - [ ] Is your name in `package/AUTHORS`? (If it is not, add it!)
 - [ ] LLM/AI disclosure was updated.

## Developers Certificate of Origin
<!-- 
In order for this PR to be merged you **must certify that you are able to submit your code to be included in MDAnalysis**.
-->

I certify that I can submit this code contribution as described in the [**Developer Certificate of Origin**](https://developercertificate.org/), under the MDAnalysis [LICENSE](https://github.com/MDAnalysis/mdanalysis/blob/develop/LICENSE).

sonu-saini19 added a commit to sonu-saini19/mdanalysis that referenced this pull request Mar 16, 2026
Fix dependency list for FULL tests in TestPyPI workflow on macOS with Python 3.13 (Issue MDAnalysis#5281, PR MDAnalysis#5310)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

more information needed Please reply to requests for information or the issue will be closed.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants