Claude/modest sagan 4m94q0 - #2
Merged
Merged
Conversation
- Convert all informal args:/returns: style docstrings to NumPy-style Parameters/Returns sections that numpydoc can parse correctly - Add missing docstrings to all previously undocumented public functions and classes (getConcurrence, calcTimeEvo, prepareBathArgs, tt.py dataclasses, abstract_pulse methods, ssh module functions, etc.) - Fix wrong/missing parameter names in existing docstrings - Fix typos (reutrns, rorating, roration, witdh) - Fix malformed RST (missing spaces after :: in autofunction directives) - Remove duplicate sphinx.ext.autodoc entry from conf.py - Add sys.modules mocking in conf.py so ttheom imports cleanly in the docs build environment without requiring GUI/HPC dependencies - Add numpydoc_show_class_members = False to suppress stub-file warnings from autosummary for class methods Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_013BxsoSLohB7jw2D72nJRpx
The Sphinx docs build with mocked matplotlib creates this stray directory because mpl.get_configdir() returns a MagicMock object at import time. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_013BxsoSLohB7jw2D72nJRpx
- Rewrite index.rst with project description, feature list, install snippet and a minimal working code example - Add quickstart.rst with step-by-step 1Q and 2Q examples, parameter descriptions, and analysis snippets - Rewrite guide/guide.rst with three worked examples (single-qubit, realistic single-qubit, two-qubit Bell state), bath decomposition section, convergence guidance, and HPC submission example - Improve gui/gui.rst with feature descriptions and fixed RST title - Expand apidoc/functions.rst to include evaluation functions and high-level simulation API - Reorganise apidoc/classes.rst (remove duplicated entries, add sections) - Fix copyright.rst: replace all qDNA/QuantumDNA references with TensorHEOM - conf.py: add html_logo, html_theme_options, html_context; remove duplicate exclude_patterns and unsupported display_version option - evaluation/__init__.py: export getLogarithmicNegativity - main.py: fix dtFB unit in calcTimeEvo docstring (ps, not fs) - Build passes sphinx -W --keep-going with zero warnings Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_013BxsoSLohB7jw2D72nJRpx
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
2 participants
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.
No description provided.