Skip to content

Fix rtd build after migration to pyproject toml#1445

Merged
HenrZu merged 8 commits intomainfrom
Fix-rtd-build-after-migration-to-pyproject-toml
Dec 8, 2025
Merged

Fix rtd build after migration to pyproject toml#1445
HenrZu merged 8 commits intomainfrom
Fix-rtd-build-after-migration-to-pyproject-toml

Conversation

@HenrZu
Copy link
Copy Markdown
Contributor

@HenrZu HenrZu commented Dec 4, 2025 •
edited
Loading

Changes and Information

Please briefly list the changes (main added features, changed items, or corrected bugs) made:

  • Mock Simulation and Generation pkg

If need be, add additional information and what the reviewer should look out for in particular:

Merge Request - Guideline Checklist

Please check our git workflow. Use the draft feature if the Pull Request is not yet ready to review.

Checks by code author

  • Every addressed issue is linked (use the "Closes #ISSUE" keyword below)
  • New code adheres to coding guidelines
  • No large data files have been added (files should in sum not exceed 100 KB, avoid PDFs, Word docs, etc.)
  • Tests are added for new functionality and a local test run was successful (with and without OpenMP)
  • Appropriate documentation within the code (Doxygen) for new functionality has been added in the code
  • Appropriate external documentation (ReadTheDocs) for new functionality has been added to the online documentation
  • Proper attention to licenses, especially no new third-party software with conflicting license has been added
  • (For ABM development) Checked benchmark results and ran and posted a local test above from before and after development to ensure performance is monitored.

Checks by code reviewer(s)

  • Corresponding issue(s) is/are linked and addressed
  • Code is clean of development artifacts (no deactivated or commented code lines, no debugging printouts, etc.)
  • Appropriate unit tests have been added, CI passes, code coverage and performance is acceptable (did not decrease)
  • No large data files added in the whole history of commits(files should in sum not exceed 100 KB, avoid PDFs, Word docs, etc.)
  • On merge, add 2-5 lines with the changes (main added features, changed items, or corrected bugs) to the merge-commit-message. This can be taken from the briefly-list-the-changes above (best case) or the separate commit messages (worst case).

@codecov
Copy link
Copy Markdown

codecov bot commented Dec 4, 2025 •
edited
Loading

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.28%. Comparing base (ea3fd2f) to head (7de4307).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files 
@@            Coverage Diff             @@
##             main    #1445      +/-   ##
==========================================
- Coverage   97.31%   97.28%   -0.04%     
==========================================
  Files         187      187              
  Lines       16024    16024              
==========================================
- Hits        15594    15589       -5     
- Misses        430      435       +5

☔ 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.

@HenrZu HenrZu requested a review from kilianvolmer December 5, 2025 07:32
kilianvolmer
kilianvolmer requested changes Dec 5, 2025
View reviewed changes
Copy link
Copy Markdown
Contributor

@kilianvolmer kilianvolmer left a comment

Choose a reason for hiding this comment

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

The pages that list the functions for the memilio-simulation package have hand-written headers, but still require autodocs to actually generate the documentation. This currently works (https://memilio.readthedocs.io/en/latest/pythonapi/memilio.simulation.html) but breaks when not installing memilio-simulation anymore. Can we find a way to install memilio-simulation?

@HenrZu
Copy link
Copy Markdown
Contributor Author

HenrZu commented Dec 5, 2025

As dicussed, we will move this into #1448
The problem is that we now use scikit_build_core which is way more sensitive to the structure from readthedocs.
Currently, my only solution would be to add a setup.py again for the doc. This needs to be further iterated (considering what the added value of the python API is to the existing (and working) rst files). So, for now we should merge this, to make the doc work again :)

@kilianvolmer
Copy link
Copy Markdown
Contributor

kilianvolmer commented Dec 5, 2025

I think we should remove the memilio.simulation.*.rst files in docs/source/pythonapi as they are now useless. Then we can merge this :)

@HenrZu HenrZu merged commit 092c0e0 into main Dec 8, 2025
57 checks passed
@HenrZu HenrZu deleted the Fix-rtd-build-after-migration-to-pyproject-toml branch December 8, 2025 09:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@kilianvolmer kilianvolmer kilianvolmer approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@HenrZu @kilianvolmer