Improved constraints + doc migration - #400
Merged
Merged
Conversation
* 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
* move everything to MKDocs minor updates/fixes after code review * ruff fix for notebook
rozyczko
added
[scope] enhancement
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
Codecov Report❌ Patch coverage is Additional details and impacted files@@ Coverage Diff @@
## develop #400 +/- ##
===========================================
+ Coverage 93.69% 93.97% +0.28%
===========================================
Files 51 54 +3
Lines 4519 5177 +658
===========================================
+ Hits 4234 4865 +631
- Misses 285 312 +27
Flags with carried forward coverage won't be shown. Click here to find out more.
🚀 New features to boost your workflow:
|
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>
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 build process, and introduces new and expanded documentation for constraints, Bayesian analysis, and other API topics. It also updates changelogs and tutorials to reflect new features and conventions, such as parameter constraints and usage of
.min/.maxinstead of.bounds. The Sphinx build workflow and related files are removed.Documentation system migration and workflow changes:
docs/Makefile, the legacy Sphinx tree, and the.github/workflows/documentation-build.ymlworkflow. Documentation is now built and deployed using MkDocs (Material) viadocs.ymland configured indocs/mkdocs.yml..github/copilot-instructions.mdto require NumPy-style docstrings and MkDocs for documentation builds, replacing Sphinx/reStructuredText references.New and expanded documentation: