docs update for seminar notebooks #2998
Open
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.
merge after flexcompute/tidy3d-notebooks#394
Greptile Overview
Greptile Summary
Adds documentation for a new fabrication-aware inverse design seminar with accompanying Jupyter notebooks. The PR updates Sphinx configuration to support nested notebooks and
.nblinkfiles, creates comprehensive seminar documentation, and updates the notebooks submodule.nbsphinx_linkextension todocs/conf.pyfor better notebook linking supportfabrication_invdes.rstwith detailed seminar overview covering Bayesian optimization, adjoint methods, and fabrication sensitivityConfidence Score: 3/5
docs/lectures/fabrication_invdes.rst- verify the correct seminar date before mergingImportant Files Changed
File Analysis
nbsphinx_linkextension and patterns for nested notebooks and.nblinkfiles to support new seminar structureSequence Diagram
sequenceDiagram participant Dev as Developer participant Sphinx as Sphinx Builder participant NBSphinx as nbsphinx/nbsphinx_link participant Submodule as notebooks Submodule participant Docs as Generated Docs Dev->>Sphinx: Update conf.py (add nbsphinx_link extension) Dev->>Sphinx: Add include patterns for nested notebooks Dev->>Submodule: Update pointer to new commit (2ab8625) Dev->>Sphinx: Create fabrication_invdes.rst Dev->>Sphinx: Create fabrication_invdes_notebooks.rst Dev->>Sphinx: Update lectures/index.rst Note over Sphinx,Docs: Build Process Sphinx->>NBSphinx: Process notebook patterns NBSphinx->>Submodule: Resolve .nblink files Submodule-->>NBSphinx: Return notebook references NBSphinx->>Sphinx: Generate notebook pages Sphinx->>Docs: Build lecture index with new seminar Sphinx->>Docs: Render fabrication_invdes page with toctree Docs-->>Dev: Documentation site with new seminar section