Updated of the forge from github with image system online

docs/source/conf.py

@@ -0,0 +1,43 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = 'mxpic_handbook'
+copyright = '2026, Qin Yue (PotatoMaxwell)'
+author = 'Qin Yue (PotatoMaxwell)'
+release = 'mxpic'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+import os
+import sys
+sys.path.insert(0, os.path.abspath('..\\'))  # Points to your mxpic code
+sys.path.insert(0, os.path.abspath('..\\..\\'))  # Points to your mxpic code
+# sys.path.insert(0, os.path.abspath('..\\..\\..\\'))  # Points to your mxpic code
+
+extensions = [
+    'sphinx.ext.autodoc',       # Automatically pull docstrings
+    'sphinx.ext.napoleon',      # Support for NumPy-style docstrings
+    'myst_parser',              # Support for Markdown[cite: 1]
+    'sphinx_autodoc_typehints', # Use your Python type hints[cite: 1]
+]
+
+source_suffix = {
+    '.rst': 'restructuredtext',
+    '.md': 'markdown',
+}
+
+templates_path = ['_templates']
+exclude_patterns = []
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = "pydata_sphinx_theme"
+
+

docs/source/index.md

@@ -0,0 +1,16 @@
+.. mxpic_handbook documentation master file, created by
+sphinx-quickstart on Sun May  3 16:05:57 2026.
+You can adapt this file completely to your liking, but it should at least
+contain the root `toctree` directive.
+
+# Welcome to the automated documentation for the mxPIC silicon photonics library.
+```{toctree}
+   :maxdepth: 2
+   :caption: Components:
+
+mxpic/components/primitives/beam_splitters
+mxpic/components/primitives/directional_couplers
+mxpic/components/primitives/EC_dual_layer_px3
+mxpic/components/primitives/grating_couplers
+mxpic/components/primitives/multimode_interferometers
+mxpic/components/primitives/spiral

docs/source/mxpic/components/primitives/EC_dual_layer_px3.md

@@ -0,0 +1,20 @@
+# mxpic.components.primitives.EC_dual_layer_px3
+
+```{eval-rst}
+.. automodule:: mxpic.components.primitives.EC_dual_layer_px3
+   :no-members:
+```
+
+## 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:
+   :show-inheritance:
+```
+

docs/source/mxpic/components/primitives/beam_splitters.md

@@ -0,0 +1,33 @@
+# mxpic.components.primitives.beam_splitters
+
+```{eval-rst}
+.. automodule:: mxpic.components.primitives.beam_splitters
+   :no-members:
+```
+
+## YBranch
+
+```{eval-rst}
+.. image:: YBranch.png
+   :align: center
+   :width: 600px
+
+.. autoclass:: mxpic.components.primitives.beam_splitters.YBranch
+   :members:
+   :undoc-members:
+   :show-inheritance:
+```
+
+## Ybranch_3wg
+
+```{eval-rst}
+.. image:: Ybranch_3wg.png
+   :align: center
+   :width: 600px
+
+.. autoclass:: mxpic.components.primitives.beam_splitters.Ybranch_3wg
+   :members:
+   :undoc-members:
+   :show-inheritance:
+```
+

docs/source/mxpic/components/primitives/directional_couplers.md

@@ -0,0 +1,98 @@
+# mxpic.components.primitives.directional_couplers
+
+```{eval-rst}
+.. automodule:: mxpic.components.primitives.directional_couplers
+   :no-members:
+```
+
+## ADC_STD_2x2
+
+```{eval-rst}
+.. image:: ADC_STD_2x2.png
+   :align: center
+   :width: 600px
+
+.. autoclass:: mxpic.components.primitives.directional_couplers.ADC_STD_2x2
+   :members:
+   :undoc-members:
+   :show-inheritance:
+```
+
+## BS_tdc
+
+```{eval-rst}
+.. image:: BS_tdc.png
+   :align: center
+   :width: 600px
+
+.. autoclass:: mxpic.components.primitives.directional_couplers.BS_tdc
+   :members:
+   :undoc-members:
+   :show-inheritance:
+```
+
+## DC
+
+```{eval-rst}
+.. image:: DC.png
+   :align: center
+   :width: 600px
+
+.. autoclass:: mxpic.components.primitives.directional_couplers.DC
+   :members:
+   :undoc-members:
+   :show-inheritance:
+```
+
+## DC_bend
+
+```{eval-rst}
+.. image:: DC_bend.png
+   :align: center
+   :width: 600px
+
+.. autoclass:: mxpic.components.primitives.directional_couplers.DC_bend
+   :members:
+   :undoc-members:
+   :show-inheritance:
+```
+
+## DC_pX_3sg
+
+```{eval-rst}
+.. image:: DC_pX_3sg.png
+   :align: center
+   :width: 600px
+
+.. autoclass:: mxpic.components.primitives.directional_couplers.DC_pX_3sg
+   :members:
+   :undoc-members:
+   :show-inheritance:
+```
+
+## MDM
+
+```{eval-rst}
+.. image:: MDM.png
+   :align: center
+   :width: 600px
+
+.. autoclass:: mxpic.components.primitives.directional_couplers.MDM
+   :members:
+   :undoc-members:
+   :show-inheritance:
+```
+
+## ring_bus_wg
+
+```{eval-rst}
+.. image:: ring_bus_wg.png
+   :align: center
+   :width: 600px
+
+.. autoclass:: mxpic.components.primitives.directional_couplers.ring_bus_wg
+   :members:
+   :undoc-members:
+   :show-inheritance:
+```
+

docs/source/mxpic/components/primitives/grating_couplers.md

@@ -0,0 +1,111 @@
+# mxpic.components.primitives.grating_couplers
+
+```{eval-rst}
+.. automodule:: mxpic.components.primitives.grating_couplers
+   :no-members:
+```
+
+## FA
+
+```{eval-rst}
+.. image:: FA.png
+   :align: center
+   :width: 600px
+
+.. autoclass:: mxpic.components.primitives.grating_couplers.FA
+   :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:
+```
+
+## 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:
+```
+
+## 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:
+```
+
+## Grating_2D_Hole_3Rec
+
+```{eval-rst}
+.. image:: Grating_2D_Hole_3Rec.png
+   :align: center
+   :width: 600px
+
+.. autoclass:: mxpic.components.primitives.grating_couplers.Grating_2D_Hole_3Rec
+   :members:
+   :undoc-members:
+   :show-inheritance:
+```
+
+## Grating_2D_Hole_4Rec
+
+```{eval-rst}
+.. image:: Grating_2D_Hole_4Rec.png
+   :align: center
+   :width: 600px
+
+.. autoclass:: mxpic.components.primitives.grating_couplers.Grating_2D_Hole_4Rec
+   :members:
+   :undoc-members:
+   :show-inheritance:
+```
+
+## 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:
+```
+

docs/source/mxpic/components/primitives/multimode_interferometers.md

@@ -0,0 +1,33 @@
+# mxpic.components.primitives.multimode_interferometers
+
+```{eval-rst}
+.. automodule:: mxpic.components.primitives.multimode_interferometers
+   :no-members:
+```
+
+## MMI_ML
+
+```{eval-rst}
+.. image:: MMI_ML.png
+   :align: center
+   :width: 600px
+
+.. autoclass:: mxpic.components.primitives.multimode_interferometers.MMI_ML
+   :members:
+   :undoc-members:
+   :show-inheritance:
+```
+
+## MMI_STD
+
+```{eval-rst}
+.. image:: MMI_STD.png
+   :align: center
+   :width: 600px
+
+.. autoclass:: mxpic.components.primitives.multimode_interferometers.MMI_STD
+   :members:
+   :undoc-members:
+   :show-inheritance:
+```
+

docs/source/mxpic/components/primitives/spiral.md

@@ -0,0 +1,85 @@
+# mxpic.components.primitives.spiral
+
+```{eval-rst}
+.. automodule:: mxpic.components.primitives.spiral
+   :no-members:
+```
+
+## Spiral_Cicle_MM
+
+```{eval-rst}
+.. image:: Spiral_Cicle_MM.png
+   :align: center
+   :width: 600px
+
+.. autoclass:: mxpic.components.primitives.spiral.Spiral_Cicle_MM
+   :members:
+   :undoc-members:
+   :show-inheritance:
+```
+
+## Spiral_Cicle_STD
+
+```{eval-rst}
+.. image:: Spiral_Cicle_STD.png
+   :align: center
+   :width: 600px
+
+.. autoclass:: mxpic.components.primitives.spiral.Spiral_Cicle_STD
+   :members:
+   :undoc-members:
+   :show-inheritance:
+```
+
+## Spiral_Rect_STD
+
+```{eval-rst}
+.. image:: Spiral_Rect_STD.png
+   :align: center
+   :width: 600px
+
+.. autoclass:: mxpic.components.primitives.spiral.Spiral_Rect_STD
+   :members:
+   :undoc-members:
+   :show-inheritance:
+```
+
+## spiral
+
+```{eval-rst}
+.. image:: spiral.png
+   :align: center
+   :width: 600px
+
+.. autoclass:: mxpic.components.primitives.spiral.spiral
+   :members:
+   :undoc-members:
+   :show-inheritance:
+```
+
+## spiral_circle
+
+```{eval-rst}
+.. image:: spiral_circle.png
+   :align: center
+   :width: 600px
+
+.. autoclass:: mxpic.components.primitives.spiral.spiral_circle
+   :members:
+   :undoc-members:
+   :show-inheritance:
+```
+
+## spiral_rectangle
+
+```{eval-rst}
+.. image:: spiral_rectangle.png
+   :align: center
+   :width: 600px
+
+.. autoclass:: mxpic.components.primitives.spiral.spiral_rectangle
+   :members:
+   :undoc-members:
+   :show-inheritance:
+```
+