Merged
Conversation
Contributor
Diff CoverageDiff: origin/develop...HEAD, staged and unstaged changesNo lines with coverage information in this diff. |
daquinteroflex
force-pushed
the
hotfix/docs-build-fixes
branch
from
2b039df to
d9beeb6
Compare
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.
Note
Medium Risk
Moderate risk because it changes Sphinx build configuration, including dynamic
autosummary_generatebehavior and optional monkey-patching ofsphinx.ext.autosummaryinternals, which could affect doc builds if misconfigured.Overview
Improves docs build controls by generating
autosummarystubs from discovered.rstfiles during full builds (excluding_autosummary), and adds**/.venv/**to Sphinxexclude_patterns.Adds optional environment-driven knobs:
TIDY3D_DOCS_ONLYto restrict the build to a selected set of.rstpages, andTIDY3D_DOCS_PROFILE_AUTOSUMMARY*to instrument autosummary generation and emit timing diagnostics to stderr.Updates the
SurfaceFieldTimeDatadocstring to more clearly describe its association withSurfaceFieldTimeMonitor.Reviewed by Cursor Bugbot for commit d9beeb6. Bugbot is set up for automated code reviews on this repo. Configure here.