1. Cython compile system build. 2. License system build. 3. Auto md file generation for Sphinx build.

This commit is contained in:
2026-05-07 13:51:42 +08:00
parent 15610b623c
commit dda69d5b84
129 changed files with 4458 additions and 516 deletions
Binary file not shown.

After

Width:  |  Height:  |  Size: 2.1 MiB

+43
View File
@@ -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"
+13
View File
@@ -0,0 +1,13 @@
.. 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/directional_couplers/directional_couplers
mxpic/components/primitives/edge_couplers/EC_dual_layer_px3
mxpic/components/primitives/grating_couplers/grating_couplers
@@ -0,0 +1,7 @@
# mxpic\components\primitives\directional_couplers\directional_couplers
```{eval-rst}
.. automodule:: mxpic.components.primitives.directional_couplers.directional_couplers
:members:
:undoc-members:
:show-inheritance:
```
@@ -0,0 +1,7 @@
# mxpic\components\primitives\edge_couplers\EC_dual_layer_px3
```{eval-rst}
.. automodule:: mxpic.components.primitives.edge_couplers.EC_dual_layer_px3
:members:
:undoc-members:
:show-inheritance:
```
@@ -0,0 +1,7 @@
# mxpic\components\primitives\grating_couplers\grating_couplers
```{eval-rst}
.. automodule:: mxpic.components.primitives.grating_couplers.grating_couplers
:members:
:undoc-members:
:show-inheritance:
```