Updated docs - #398
Merged
Merged
Conversation
minor updates/fixes after code review
Codecov Report❌ Patch coverage is Additional details and impacted files@@ Coverage Diff @@
## improved_constraints #398 +/- ##
========================================================
- Coverage 93.89% 93.87% -0.03%
========================================================
Files 54 54
Lines 5098 5173 +75
========================================================
+ Hits 4787 4856 +69
- Misses 311 317 +6
Flags with carried forward coverage won't be shown. Click here to find out more.
🚀 New features to boost your workflow:
|
rozyczko
added
[scope] documentation
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
rozyczko
added a commit
that referenced
this pull request
Sep 1, 2026
* initial version * added magnetic SLD profile * added magnetic parameters * ruff * code review comments addressed * code review fixes for Phase 2, added notebook * ruff * PR code review comments * fixed polarized file load issue * enable magnetic layers * new LayerMagnetism component * ruff * ruff on notebooks * bind calculator to model for performance * attempt at fixing package testing * package tests only on master * don't run ruff twice * code review fixes * added polarized fitting example/notebook * fixed default sample generation * improved wording in the magnetic fitting notebook * move the most expensive test to integration * Improved constraints (#395) * improved handling of constraints * ruff * wording * additional cell in a notebook to showcase the new way of doing constraints * fixed notebook * initial checkin * .bounds -> min, max * updates so the code is self-contained and doesn't depend on changes to core * Code review comments addressed * Updated docs (#398) * move everything to MKDocs minor updates/fixes after code review * ruff fix for notebook * Fix broken conflict resolutions from develop merge The merge of develop (2042778) left two files with damaged conflict resolutions: magnetism.ipynb gained a corrupt hybrid cell (invalid notebook JSON, duplicate cell id) and project.py gained a duplicated copy of the spin-asymmetry method block with an orphaned method body. Both files are restored to the branch-side version, which already contained everything develop had for them. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * code review issues addressed * removed explicit EasyCore constraints factory reliance --------- Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request migrates the documentation system from Sphinx to MkDocs (Material), updates the documentation structure, and adds new tutorials and API reference pages. It also introduces new features for parameter constraints and improves the handling and documentation of conformal thickness/roughness in multilayers. The Sphinx documentation workflow and files are removed, and the documentation build process is now handled by MkDocs.
Documentation system migration and workflow changes:
.github/copilot-instructions.mdto require NumPy-style docstrings and MkDocs configuration, and removing all Sphinx-specific files and thedocumentation-build.ymlworkflow. Documentation is now built and deployed viadocs.ymlfromdocs/mkdocs.yml, with all pages listed in the navigation.Documentation structure and content improvements:
New features and enhancements for parameter constraints:
clamp_sum_partnersandrestore_sum_partnersto prevent negative remainder inconstrain_to_sumconstraints, with persisted maxima across save/load, andis_constrained_to_sumto check constraint status.easyreflectometry.UnitErrorfor unit problems in inequality constraints, subclassingValueErrorfor backward compatibility.Improvements to conformal thickness/roughness in multilayers:
conformal_thicknessandconformal_roughnesstoggles inMultilayerandRepeatingMultilayerassemblies, including their serialization and behavior on save/load.