Skip to content

skpkg: Update rst files, copyright year in license, and autodoc_mock_import #139

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

Merged
merged 5 commits into from
Jun 13, 2025

Conversation

cadenmyers13
Copy link
Contributor

I reverted back to the old license and just changed the copyright year to 2025 there. Please check the conf.py file to see if doing the mock import for package api rendering is okay. Otherwise I could not get the package API to render locally when i built docs. The rest of the edits here are small formatting things to conform with skpkg and

@@ -53,6 +53,10 @@
"m2r",
]

autodoc_mock_imports = [
"diffpy.pdffit2.pdffit2",
]
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Added this so I could get API to render properly when i built docs.

Copy link

codecov bot commented Jun 13, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.97%. Comparing base (74add76) to head (4f5d7a7).
Report is 9 commits behind head on migration.

Additional details and impacted files
@@            Coverage Diff             @@
##           migration     #139   +/-   ##
==========================================
  Coverage      98.97%   98.97%           
==========================================
  Files              6        6           
  Lines           1267     1267           
==========================================
  Hits            1254     1254           
  Misses            13       13           
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@sbillinge sbillinge merged commit edc5bd0 into diffpy:migration Jun 13, 2025
4 checks passed
@sbillinge
Copy link
Contributor

Very nice! Thanks for the extensive explanations

@cadenmyers13
Copy link
Contributor Author

@sbillinge Thanks! Sorry about the licensing mishaps 😆 I'll be more thorough moving forward 🫡

@cadenmyers13
Copy link
Contributor Author

@sbillinge I'll test this if they're tutorials then this should be good to merge into main

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