build_all, build_images, build_handbook revised so that the html is not ready to use.

2026-06-07 20:30:23 +08:00
parent 54d20eb154
commit a4ac88f002
334 changed files with 1309 additions and 8710 deletions
@@ -1,12 +1,10 @@
 # Geometry

-Reusable geometry structures used by component and primitive generators.
-
 ```{toctree}
   :maxdepth: 2

-polygons
-rings
 curves
+polygons
 racetrack
+rings
 ```
@@ -5,12 +5,11 @@

 composites/index
 electronics/index
+geometry/index
 others/index
-pdks/index
 primitives/index
 basic
 gds_devices
 pins
 routing
-geometry/index
 ```
@@ -8,10 +8,6 @@
 ## EC_dual_layer_px3

 ```{eval-rst}
-.. image:: EC_dual_layer_px3.png
-   :align: center
-   :width: 600px
-
 .. autoclass:: mxpic.components.primitives.EC_dual_layer_px3.EC_dual_layer_px3
   :members:
   :undoc-members:
@@ -17,6 +17,10 @@
 ## Heater_NDoped

 ```{eval-rst}
+.. image:: ../../../../images/active/Heater_NDoped.png
+   :align: center
+   :width: 600px
+
 .. autoclass:: mxpic.components.primitives.active.dev_ps.Heater_NDoped
   :members:
   :undoc-members:
@@ -26,6 +30,10 @@
 ## PS_PIN

 ```{eval-rst}
+.. image:: ../../../../images/active/PS_PIN.png
+   :align: center
+   :width: 600px
+
 .. autoclass:: mxpic.components.primitives.active.dev_ps.PS_PIN
   :members:
   :undoc-members:
@@ -8,6 +8,10 @@
 ## waveguide_PIN

 ```{eval-rst}
+.. image:: ../../../../images/active/waveguide_PIN.png
+   :align: center
+   :width: 600px
+
 .. autoclass:: mxpic.components.primitives.active.pin_wg.waveguide_PIN
   :members:
   :undoc-members:
@@ -17,6 +21,10 @@
 ## WGDoped

 ```{eval-rst}
+.. image:: ../../../../images/active/WGDoped.png
+   :align: center
+   :width: 600px
+
 .. autoclass:: mxpic.components.primitives.active.pin_wg.WGDoped
   :members:
   :undoc-members:
@@ -17,6 +17,10 @@
 ## AED_Ring_PIN

 ```{eval-rst}
+.. image:: ../../../../images/active/AED_Ring_PIN.png
+   :align: center
+   :width: 600px
+
 .. autoclass:: mxpic.components.primitives.active.rings.AED_Ring_PIN
   :members:
   :undoc-members:
@@ -26,6 +30,10 @@
 ## STD_Ring_PIN

 ```{eval-rst}
+.. image:: ../../../../images/active/STD_Ring_PIN.png
+   :align: center
+   :width: 600px
+
 .. autoclass:: mxpic.components.primitives.active.rings.STD_Ring_PIN
   :members:
   :undoc-members:
@@ -35,6 +43,10 @@
 ## PIN_MRR_MM_Allpass

 ```{eval-rst}
+.. image:: ../../../../images/active/PIN_MRR_MM_Allpass.png
+   :align: center
+   :width: 600px
+
 .. autoclass:: mxpic.components.primitives.active.rings.PIN_MRR_MM_Allpass
   :members:
   :undoc-members:
@@ -44,6 +56,10 @@
 ## PIN_MRR_MM_Adddrop

 ```{eval-rst}
+.. image:: ../../../../images/active/PIN_MRR_MM_Adddrop.png
+   :align: center
+   :width: 600px
+
 .. autoclass:: mxpic.components.primitives.active.rings.PIN_MRR_MM_Adddrop
   :members:
   :undoc-members:
@@ -53,6 +69,10 @@
 ## PIN_MRR_STD_Allpass

 ```{eval-rst}
+.. image:: ../../../../images/active/PIN_MRR_STD_Allpass.png
+   :align: center
+   :width: 600px
+
 .. autoclass:: mxpic.components.primitives.active.rings.PIN_MRR_STD_Allpass
   :members:
   :undoc-members:
@@ -5,80 +5,6 @@
   :no-members:
 ```

-## Nano_ant
-
-```{eval-rst}
-.. image:: Nano_ant.png
-   :align: center
-   :width: 600px
-
-.. autoclass:: mxpic.components.primitives.grating_couplers.Nano_ant
-   :members:
-   :undoc-members:
-   :show-inheritance:
-```
-
-## Taper
-
-```{eval-rst}
-.. image:: Taper.png
-   :align: center
-   :width: 600px
-
-.. autoclass:: mxpic.components.primitives.grating_couplers.Taper
-   :members:
-   :undoc-members:
-   :show-inheritance:
-```
-
-## Grating_2D_Hole
-
-```{eval-rst}
-.. image:: Grating_2D_Hole.png
-   :align: center
-   :width: 600px
-
-.. autoclass:: mxpic.components.primitives.grating_couplers.Grating_2D_Hole
-   :members:
-   :undoc-members:
-   :show-inheritance:
-```
-
-## GC_STD_2D
-
-```{eval-rst}
-.. image:: GC_STD_2D.png
-   :align: center
-   :width: 600px
-
-.. autoclass:: mxpic.components.primitives.grating_couplers.GC_STD_2D
-   :members:
-   :undoc-members:
-   :show-inheritance:
-```
-
-## GC_STD_1D
-
-```{eval-rst}
-.. image:: GC_STD_1D.png
-   :align: center
-   :width: 600px
-
-.. autoclass:: mxpic.components.primitives.grating_couplers.GC_STD_1D
-   :members:
-   :undoc-members:
-   :show-inheritance:
-```
-
-## FA
-
-```{eval-rst}
-.. autoclass:: mxpic.components.primitives.grating_couplers.FA
-   :members:
-   :undoc-members:
-   :show-inheritance:
-```
-
 ## GC_SiN_Si_Dual_Layer

 ```{eval-rst}
@@ -7,9 +7,5 @@ active/index
 passive/index
 pic/index
 EC_dual_layer_px3
-beam_splitters
-directional_couplers
 grating_couplers
-multimode_interferometers
-spiral
 ```
@@ -17,6 +17,10 @@
 ## CROW_Eul_Ring

 ```{eval-rst}
+.. image:: ../../../../images/passive/CROW_Eul_Ring.png
+   :align: center
+   :width: 600px
+
 .. autoclass:: mxpic.components.primitives.passive.crows.CROW_Eul_Ring
   :members:
   :undoc-members:
@@ -26,6 +30,10 @@
 ## CROW_Eul_RCK

 ```{eval-rst}
+.. image:: ../../../../images/passive/CROW_Eul_RCK.png
+   :align: center
+   :width: 600px
+
 .. autoclass:: mxpic.components.primitives.passive.crows.CROW_Eul_RCK
   :members:
   :undoc-members:
@@ -44,6 +52,10 @@
 ## CROW_STD_Allpass

 ```{eval-rst}
+.. image:: ../../../../images/passive/CROW_STD_Allpass.png
+   :align: center
+   :width: 600px
+
 .. autoclass:: mxpic.components.primitives.passive.crows.CROW_STD_Allpass
   :members:
   :undoc-members:
@@ -53,6 +65,10 @@
 ## CROW_STD_Adddrop

 ```{eval-rst}
+.. image:: ../../../../images/passive/CROW_STD_Adddrop.png
+   :align: center
+   :width: 600px
+
 .. autoclass:: mxpic.components.primitives.passive.crows.CROW_STD_Adddrop
   :members:
   :undoc-members:
@@ -62,6 +78,10 @@
 ## CROW_AED

 ```{eval-rst}
+.. image:: ../../../../images/passive/CROW_AED.png
+   :align: center
+   :width: 600px
+
 .. autoclass:: mxpic.components.primitives.passive.crows.CROW_AED
   :members:
   :undoc-members:
@@ -71,6 +71,10 @@
 ## MRR_STD_Allpass

 ```{eval-rst}
+.. image:: ../../../../images/passive/MRR_STD_Allpass.png
+   :align: center
+   :width: 600px
+
 .. autoclass:: mxpic.components.primitives.passive.rings.MRR_STD_Allpass
   :members:
   :undoc-members:
@@ -80,6 +84,10 @@
 ## MRR_STD_Adddrop

 ```{eval-rst}
+.. image:: ../../../../images/passive/MRR_STD_Adddrop.png
+   :align: center
+   :width: 600px
+
 .. autoclass:: mxpic.components.primitives.passive.rings.MRR_STD_Adddrop
   :members:
   :undoc-members:
@@ -89,6 +97,10 @@
 ## MRR_MM_Allpass

 ```{eval-rst}
+.. image:: ../../../../images/passive/MRR_MM_Allpass.png
+   :align: center
+   :width: 600px
+
 .. autoclass:: mxpic.components.primitives.passive.rings.MRR_MM_Allpass
   :members:
   :undoc-members:
@@ -98,6 +110,10 @@
 ## MRR_MM_Adddrop

 ```{eval-rst}
+.. image:: ../../../../images/passive/MRR_MM_Adddrop.png
+   :align: center
+   :width: 600px
+
 .. autoclass:: mxpic.components.primitives.passive.rings.MRR_MM_Adddrop
   :members:
   :undoc-members:
@@ -107,6 +123,10 @@
 ## MRR_DW_Adddrop

 ```{eval-rst}
+.. image:: ../../../../images/passive/MRR_DW_Adddrop.png
+   :align: center
+   :width: 600px
+
 .. autoclass:: mxpic.components.primitives.passive.rings.MRR_DW_Adddrop
   :members:
   :undoc-members:
@@ -116,6 +136,10 @@
 ## MRR_DW_Allpass

 ```{eval-rst}
+.. image:: ../../../../images/passive/MRR_DW_Allpass.png
+   :align: center
+   :width: 600px
+
 .. autoclass:: mxpic.components.primitives.passive.rings.MRR_DW_Allpass
   :members:
   :undoc-members:
@@ -125,6 +149,10 @@
 ## STD_ring_AMZI_adddrop

 ```{eval-rst}
+.. image:: ../../../../images/passive/STD_ring_AMZI_adddrop.png
+   :align: center
+   :width: 600px
+
 .. autoclass:: mxpic.components.primitives.passive.rings.STD_ring_AMZI_adddrop
   :members:
   :undoc-members:
@@ -8,6 +8,10 @@
 ## waveguide

 ```{eval-rst}
+.. image:: ../../../../images/passive/waveguide.png
+   :align: center
+   :width: 600px
+
 .. autoclass:: mxpic.components.primitives.passive.unit.waveguide
   :members:
   :undoc-members:
@@ -17,6 +21,10 @@
 ## PS_2st

 ```{eval-rst}
+.. image:: ../../../../images/passive/PS_2st.png
+   :align: center
+   :width: 600px
+
 .. autoclass:: mxpic.components.primitives.passive.unit.PS_2st
   :members:
   :undoc-members:
@@ -26,6 +34,10 @@
 ## PS_2st_Straight

 ```{eval-rst}
+.. image:: ../../../../images/passive/PS_2st_Straight.png
+   :align: center
+   :width: 600px
+
 .. autoclass:: mxpic.components.primitives.passive.unit.PS_2st_Straight
   :members:
   :undoc-members:
@@ -35,6 +47,10 @@
 ## PSR_1x2

 ```{eval-rst}
+.. image:: ../../../../images/passive/PSR_1x2.png
+   :align: center
+   :width: 600px
+
 .. autoclass:: mxpic.components.primitives.passive.unit.PSR_1x2
   :members:
   :undoc-members:
@@ -44,6 +60,10 @@
 ## Brag_WDM

 ```{eval-rst}
+.. image:: ../../../../images/passive/Brag_WDM.png
+   :align: center
+   :width: 600px
+
 .. autoclass:: mxpic.components.primitives.passive.unit.Brag_WDM
   :members:
   :undoc-members:
@@ -8,6 +8,10 @@
 ## PBS_3wg

 ```{eval-rst}
+.. image:: ../../../../images/pic/PBS_3wg.png
+   :align: center
+   :width: 600px
+
 .. autoclass:: mxpic.components.primitives.pic.PBS.PBS_3wg
   :members:
   :undoc-members:
@@ -8,6 +8,10 @@
 ## YBranch

 ```{eval-rst}
+.. image:: ../../../../images/pic/YBranch.png
+   :align: center
+   :width: 600px
+
 .. autoclass:: mxpic.components.primitives.pic.YBS.YBranch
   :members:
   :undoc-members:
@@ -17,6 +21,10 @@
 ## Ybranch_3wg

 ```{eval-rst}
+.. image:: ../../../../images/pic/Ybranch_3wg.png
+   :align: center
+   :width: 600px
+
 .. autoclass:: mxpic.components.primitives.pic.YBS.Ybranch_3wg
   :members:
   :undoc-members:
@@ -8,6 +8,10 @@
 ## Bragg_apodized

 ```{eval-rst}
+.. image:: ../../../../images/pic/Bragg_apodized.png
+   :align: center
+   :width: 600px
+
 .. autoclass:: mxpic.components.primitives.pic.bragg.Bragg_apodized
   :members:
   :undoc-members:
@@ -17,6 +21,10 @@
 ## Bragg

 ```{eval-rst}
+.. image:: ../../../../images/pic/Bragg.png
+   :align: center
+   :width: 600px
+
 .. autoclass:: mxpic.components.primitives.pic.bragg.Bragg
   :members:
   :undoc-members:
@@ -8,6 +8,10 @@
 ## ring_bus_wg

 ```{eval-rst}
+.. image:: ../../../../images/pic/ring_bus_wg.png
+   :align: center
+   :width: 600px
+
 .. autoclass:: mxpic.components.primitives.pic.couplers.ring_bus_wg
   :members:
   :undoc-members:
@@ -17,6 +21,10 @@
 ## ADC_STD_2x2

 ```{eval-rst}
+.. image:: ../../../../images/pic/ADC_STD_2x2.png
+   :align: center
+   :width: 600px
+
 .. autoclass:: mxpic.components.primitives.pic.couplers.ADC_STD_2x2
   :members:
   :undoc-members:
@@ -26,6 +34,10 @@
 ## DC

 ```{eval-rst}
+.. image:: ../../../../images/pic/DC.png
+   :align: center
+   :width: 600px
+
 .. autoclass:: mxpic.components.primitives.pic.couplers.DC
   :members:
   :undoc-members:
@@ -35,6 +47,10 @@
 ## BS_tdc

 ```{eval-rst}
+.. image:: ../../../../images/pic/BS_tdc.png
+   :align: center
+   :width: 600px
+
 .. autoclass:: mxpic.components.primitives.pic.couplers.BS_tdc
   :members:
   :undoc-members:
@@ -44,6 +60,10 @@
 ## MDM

 ```{eval-rst}
+.. image:: ../../../../images/pic/MDM.png
+   :align: center
+   :width: 600px
+
 .. autoclass:: mxpic.components.primitives.pic.couplers.MDM
   :members:
   :undoc-members:
@@ -53,6 +73,10 @@
 ## DC_bend

 ```{eval-rst}
+.. image:: ../../../../images/pic/DC_bend.png
+   :align: center
+   :width: 600px
+
 .. autoclass:: mxpic.components.primitives.pic.couplers.DC_bend
   :members:
   :undoc-members:
@@ -62,6 +86,10 @@
 ## DC_pX_3sg

 ```{eval-rst}
+.. image:: ../../../../images/pic/DC_pX_3sg.png
+   :align: center
+   :width: 600px
+
 .. autoclass:: mxpic.components.primitives.pic.couplers.DC_pX_3sg
   :members:
   :undoc-members:
@@ -8,6 +8,10 @@
 ## Cross

 ```{eval-rst}
+.. image:: ../../../../images/pic/Cross.png
+   :align: center
+   :width: 600px
+
 .. autoclass:: mxpic.components.primitives.pic.cross.Cross
   :members:
   :undoc-members:
@@ -17,6 +21,10 @@
 ## Cross_Sine

 ```{eval-rst}
+.. image:: ../../../../images/pic/Cross_Sine.png
+   :align: center
+   :width: 600px
+
 .. autoclass:: mxpic.components.primitives.pic.cross.Cross_Sine
   :members:
   :undoc-members:
@@ -8,6 +8,10 @@
 ## MMI_ML

 ```{eval-rst}
+.. image:: ../../../../images/pic/MMI_ML.png
+   :align: center
+   :width: 600px
+
 .. autoclass:: mxpic.components.primitives.pic.mmi.MMI_ML
   :members:
   :undoc-members:
@@ -17,6 +21,10 @@
 ## MMI_STD

 ```{eval-rst}
+.. image:: ../../../../images/pic/MMI_STD.png
+   :align: center
+   :width: 600px
+
 .. autoclass:: mxpic.components.primitives.pic.mmi.MMI_STD
   :members:
   :undoc-members:
@@ -17,6 +17,10 @@
 ## RacetrackResonator

 ```{eval-rst}
+.. image:: ../../../../images/pic/RacetrackResonator.png
+   :align: center
+   :width: 600px
+
 .. autoclass:: mxpic.components.primitives.pic.racetrack.RacetrackResonator
   :members:
   :undoc-members:
@@ -26,6 +30,10 @@
 ## Racetrack_STD_Allpass

 ```{eval-rst}
+.. image:: ../../../../images/pic/Racetrack_STD_Allpass.png
+   :align: center
+   :width: 600px
+
 .. autoclass:: mxpic.components.primitives.pic.racetrack.Racetrack_STD_Allpass
   :members:
   :undoc-members:
@@ -35,6 +43,10 @@
 ## Racetrack_MM_Allpass

 ```{eval-rst}
+.. image:: ../../../../images/pic/Racetrack_MM_Allpass.png
+   :align: center
+   :width: 600px
+
 .. autoclass:: mxpic.components.primitives.pic.racetrack.Racetrack_MM_Allpass
   :members:
   :undoc-members:
@@ -44,6 +56,10 @@
 ## Racetrack_MM_Adddrop

 ```{eval-rst}
+.. image:: ../../../../images/pic/Racetrack_MM_Adddrop.png
+   :align: center
+   :width: 600px
+
 .. autoclass:: mxpic.components.primitives.pic.racetrack.Racetrack_MM_Adddrop
   :members:
   :undoc-members:
@@ -8,6 +8,10 @@
 ## AED_ring

 ```{eval-rst}
+.. image:: ../../../../images/pic/AED_ring.png
+   :align: center
+   :width: 600px
+
 .. autoclass:: mxpic.components.primitives.pic.rings.AED_ring
   :members:
   :undoc-members:
@@ -17,6 +21,10 @@
 ## STD_PIC_Rings

 ```{eval-rst}
+.. image:: ../../../../images/pic/STD_PIC_Rings.png
+   :align: center
+   :width: 600px
+
 .. autoclass:: mxpic.components.primitives.pic.rings.STD_PIC_Rings
   :members:
   :undoc-members:
@@ -8,6 +8,10 @@
 ## spiral

 ```{eval-rst}
+.. image:: ../../../../images/pic/spiral.png
+   :align: center
+   :width: 600px
+
 .. autoclass:: mxpic.components.primitives.pic.spiral.spiral
   :members:
   :undoc-members:
@@ -17,6 +21,10 @@
 ## spiral_rectangle

 ```{eval-rst}
+.. image:: ../../../../images/pic/spiral_rectangle.png
+   :align: center
+   :width: 600px
+
 .. autoclass:: mxpic.components.primitives.pic.spiral.spiral_rectangle
   :members:
   :undoc-members:
@@ -26,6 +34,10 @@
 ## Spiral_Rect_STD

 ```{eval-rst}
+.. image:: ../../../../images/pic/Spiral_Rect_STD.png
+   :align: center
+   :width: 600px
+
 .. autoclass:: mxpic.components.primitives.pic.spiral.Spiral_Rect_STD
   :members:
   :undoc-members:
@@ -35,6 +47,10 @@
 ## spiral_circle

 ```{eval-rst}
+.. image:: ../../../../images/pic/spiral_circle.png
+   :align: center
+   :width: 600px
+
 .. autoclass:: mxpic.components.primitives.pic.spiral.spiral_circle
   :members:
   :undoc-members:
@@ -44,6 +60,10 @@
 ## Spiral_Cicle_MM

 ```{eval-rst}
+.. image:: ../../../../images/pic/Spiral_Cicle_MM.png
+   :align: center
+   :width: 600px
+
 .. autoclass:: mxpic.components.primitives.pic.spiral.Spiral_Cicle_MM
   :members:
   :undoc-members:
@@ -53,6 +73,10 @@
 ## Spiral_Cicle_STD

 ```{eval-rst}
+.. image:: ../../../../images/pic/Spiral_Cicle_STD.png
+   :align: center
+   :width: 600px
+
 .. autoclass:: mxpic.components.primitives.pic.spiral.Spiral_Cicle_STD
   :members:
   :undoc-members:
@@ -8,6 +8,10 @@
 ## transition

 ```{eval-rst}
+.. image:: ../../../../images/pic/transition.png
+   :align: center
+   :width: 600px
+
 .. autoclass:: mxpic.components.primitives.pic.taper.transition
   :members:
   :undoc-members:
@@ -17,6 +21,10 @@
 ## taper_xs2xs

 ```{eval-rst}
+.. image:: ../../../../images/pic/taper_xs2xs.png
+   :align: center
+   :width: 600px
+
 .. autoclass:: mxpic.components.primitives.pic.taper.taper_xs2xs
   :members:
   :undoc-members:
@@ -26,6 +34,10 @@
 ## PSR

 ```{eval-rst}
+.. image:: ../../../../images/pic/PSR.png
+   :align: center
+   :width: 600px
+
 .. autoclass:: mxpic.components.primitives.pic.taper.PSR
   :members:
   :undoc-members: