Merge pull request #31 from gdsfactory/better_docs

better docs

.github/write_components_plot.py → .github/write_cells_si220.py

@@ -3,7 +3,7 @@
 from cspdk.si220 import _cells as cells
 from cspdk.si220.config import PATH
 
-filepath = PATH.repo / "docs" / "cells.rst"
+filepath = PATH.repo / "docs" / "cells_si220.rst"
 
 skip = {}
 

.github/write_cells_sin300.py

@@ -0,0 +1,65 @@
+import inspect
+
+from cspdk.sin300 import _cells as cells
+from cspdk.sin300.config import PATH
+
+filepath = PATH.repo / "docs" / "cells_sin300.rst"
+
+skip = {}
+
+skip_plot: tuple[str, ...] = ("",)
+skip_settings: tuple[str, ...] = ()
+
+
+with open(filepath, "w+") as f:
+    f.write(
+        """
+
+Cells SiN300
+=============================
+"""
+    )
+
+    for name in sorted(cells.keys()):
+        if name in skip or name.startswith("_"):
+            continue
+        print(name)
+        sig = inspect.signature(cells[name])
+        kwargs = ", ".join(
+            [
+                f"{p}={repr(sig.parameters[p].default)}"
+                for p in sig.parameters
+                if isinstance(sig.parameters[p].default, int | float | str | tuple)
+                and p not in skip_settings
+            ]
+        )
+        if name in skip_plot:
+            f.write(
+                f"""
+
+{name}
+----------------------------------------------------
+
+.. autofunction:: cspdk.si220.cells.{name}
+
+"""
+            )
+        else:
+            f.write(
+                f"""
+
+{name}
+----------------------------------------------------
+
+.. autofunction:: cspdk.si220.cells.{name}
+
+.. plot::
+  :include-source:
+
+  import cspdk
+
+  c = cspdk.si220.cells.{name}({kwargs})
+  c.plot()
+
+"""
+            )

.pre-commit-config.yaml

@@ -15,9 +15,10 @@ repos:
       - id: trailing-whitespace
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: "v0.1.7"
+    rev: "v0.4.1"
     hooks:
       - id: ruff
+        args: [ --fix, --exit-non-zero-on-fix ]
       - id: ruff-format
 
   - repo: https://github.com/shellcheck-py/shellcheck-py

Makefile

@@ -22,6 +22,8 @@ notebooks:
 	jupytext docs/**/*.py --to ipynb
 
 docs:
+	python .github/write_cells_si220.py
+	python .github/write_cells_sin300.py
 	jb build docs
 
 .PHONY: drc doc docs

cspdk/si220/import_pdk.py

@@ -1,4 +1,4 @@
-""" From a list of GDS files, generate a script to import the cells from a pdk """
+"""From a list of GDS files, generate a script to import the cells from a pdk"""
 
 import gdsfactory as gf
 

cspdk/si220/samples/get_route_sc.py

@@ -1,4 +1,4 @@
-"""`get_route` returns a Manhattan route between two ports. """
+"""`get_route` returns a Manhattan route between two ports."""
 
 import gdsfactory as gf
 

cspdk/si220/samples/mode_solver_r.py

@@ -1,4 +1,5 @@
 """Silicon rib mode solver."""
+
 import gplugins.tidy3d as gt
 
 nm = 1e-3

cspdk/si220/samples/mode_solver_s.py

@@ -1,4 +1,5 @@
 """Silicon mode solver."""
+
 import gplugins.tidy3d as gt
 
 nm = 1e-3

cspdk/sin300/import_pdk.py

@@ -1,4 +1,4 @@
-""" From a list of GDS files, generate a script to import the cells from a pdk """
+"""From a list of GDS files, generate a script to import the cells from a pdk"""
 
 import gdsfactory as gf
 

cspdk/sin300/samples/get_route_nc.py

@@ -1,4 +1,4 @@
-"""`get_route` returns a Manhattan route between two ports. """
+"""`get_route` returns a Manhattan route between two ports."""
 
 import gdsfactory as gf
 

cspdk/sin300/samples/mode_solver_n.py

@@ -1,4 +1,5 @@
 """Nitride mode solver."""
+
 import gplugins.tidy3d as gt
 
 nm = 1e-3

docs/_toc.yml

@@ -11,5 +11,6 @@ parts:
   #         - file: notebooks/demo
   - caption: Reference
     chapters:
-      - file: cells
+      - file: cells_si220
+      - file: cells_sin300
       - file: changelog