Conversation
oameye
marked this pull request as ready for review
September 8, 2026 08:52
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
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.
Summary
Reorganize the documentation so the tutorial, manual, theory, and public docstrings each have a distinct role without duplicating the same material.
Manual
Adds compact manual pages for:
Public docstrings are embedded at the point where each API concept is introduced and rendered collapsed. The surrounding prose is limited to workflow, modeling choices, ordering, representation changes, and how successive operations fit together.
The numerical-lowering section also preserves the reduced-basis workflow where
operatorssubstitutions map a symbolic derivation onto a deliberately smaller numerical Hilbert space.Theory
Replaces the monolithic theory page with focused theory pages while preserving the independent mathematical content, including:
The equations follow the package conventions and cite the bibliography from the parent documentation PR.
Docstrings
Strengthens public docstrings for the core SLH interface, composition and feedback, numerical translation, pulse couplings, effective modes, delay couplings, correlation matrices, and interaction-picture utilities. Function signatures, accepted inputs, return semantics, solver forwarding, normalization conventions, and numerical special cases live in the docstrings rather than being repeated in manual prose.
Cleanup
Removes the standalone API, implementation, and monolithic theory pages whose responsibilities are now split between the compact manual, focused theory pages, and source docstrings. The executable end-to-end tutorial remains separate.
This PR changes documentation and docstrings only; it does not intentionally change package behavior. It is stacked on
docs/floquet-style.