Repository navigation
docs: TOC nesting fix + clarify compile_model backends (ils_*) - #4
Merged
Merged
Conversation
api.md section headers are ## (h2); mkdocstrings was rendering symbols at heading_level 2, making them siblings of the sections instead of children, so the TOC was flat. Bump to heading_level 3 -> symbols are h3 under each h2 section, members h4 under their class.
- method: document the real keyword set (auto/bell/single_layer/integral). The numerical inverse-Laplace path keys on "integral" (compile.py:174), not "nested" as the docstring claimed — passing "nested" at depth<=1 silently falls through to single_layer. - ils_method / ils_params: state explicitly they are used ONLY by method="integral" and ignored by the bell and single_layer backends (which assemble the density analytically).
The decorator docstring used a 'Usage:' section (not a Google section) with an unfenced indented code block, so mkdocstrings parsed it as Markdown and the Python comment '# Can instantiate...' rendered as a stray heading. Switch to a recognized 'Examples:' section with a fenced ```python block; the code now renders as code and the bogus heading is gone.
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.
Two doc fixes that landed on
examples-and-docsjust after #3 was merged (so they missed the merge point).09751b9TOC nesting:api.mdsection headers are##(h2) but mkdocstrings rendered symbols atheading_level: 2, making e.g.acopula.copulaa sibling of "Defining a copula" instead of a child — flat TOC. Bumped toheading_level: 3→ symbols nest as h3 under each h2 section, members h4 under their class.5ec815ccompile_model backends:methoddoc listed"nested"but the dispatch keys on"integral"(compile.py:174); documented the real set (auto/bell/single_layer/integral).ils_method/ils_paramsnow state explicitly they are used only bymethod="integral"and ignored bybellandsingle_layer.mkdocs build --strictclean.