FEAT: Improvements throughout ✏️

Author: daquinteroflex

.github/workflows/sync-to-readthedocs-repo.yaml

@@ -7,7 +7,6 @@ on:
       - main
       - latest
       - 'pre/*'
-      - dario/quick_patches_pre/2.6
   workflow_dispatch:
     inputs:
       env:

.gitignore

@@ -102,6 +102,7 @@ pip-log.txt
 
 # Sphinx documentation
 _docs
+_autosummary
 
 # Spyder project settings
 .spyderproject

.pre-commit-config.yaml

@@ -9,12 +9,4 @@ repos:
     rev: "v0.1.5"
     hooks:
      - id: ruff
-       args: [ --fix ]
-
-  - repo: https://github.com/codespell-project/codespell
-    rev: v2.2.6
-    hooks:
-      - id: codespell
-        args: [ --exclude-file=poetry.lock ]
-        additional_dependencies:
-          - tomli
+       args: [ --fix ]

CHANGELOG.md

@@ -9,8 +9,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - `tidy3d.plugins.design` tool to explore user-defined design spaces.
 - `ModeData.dispersion` and `ModeSolverData.dispersion` are calculated together with the group index.
 - A utility function `td.medium_from_nk()` that automatically constructs a dispersivless medium when permittivity>=1, and a single-pole Lorentz medium when permittivity<1.
+- Integration of the `documentation` alongside the main codebase repository.
+- Integration of the `tidy3d-notebooks` repository.
+- `tidy3d develop` CLI and development guide on the main documentation.
 
 ### Changed
+- `poetry` based installation. Removal of `setup.py` and `requirements.txt`.
+- Upgrade to sphinx 6 for the documentation build, and change of theme.
 
 ### Fixed
 
@@ -805,12 +810,12 @@ which fields are to be projected is now determined automatically based on the me
 ### Added
 
 - New `grid_spec` Field in `Simulation` that allows more flexibility in defining the mesh.
-- `GridSpec1d` class defining how the meshing along each dimension should be done, with sublcasses `UniformGrid` and `CustomGrid` that cover the functionality 
+- `GridSpec1d` class defining how the meshing along each dimension should be done, with subclasses `UniformGrid` and `CustomGrid` that cover the functionality 
   previously offered by supplying a float or a list of floats to `Simulation.grid_size`. New functionality offered by `AutoGrid` subclass, with the 
   mesh automatically generated based on the minimum required steps per wavelength.
 - New `PointDipole` source.
 - Opacity kwargs for monitor and source in `sim.plot`.
-- Separated `plotly`-based requirements from core requrements file, can be added with `"pip install tidy3d-beta[plotly]"`.
+- Separated `plotly`-based requirements from core requirements file, can be added with `"pip install tidy3d-beta[plotly]"`.
 
 ### Changed
 - `Simulation.grid_spec` uses the default `GridSpec`, which has `AutoGrid(min_steps_per_wvl=10)` in each direction. To initialize a `Simulation` then it is no 
@@ -952,7 +957,7 @@ which fields are to be projected is now determined automatically based on the me
 - PML parameters and padding Grid with pml pixels by [@momchil-flex](https://github.com/momchil-flex) in #64
 - Documentation by [@tylerflex](https://github.com/tylerflex) in #63
 - Gds import from [@tylerflex](https://github.com/tylerflex) in #69
-- Loggin by [@tylerflex](https://github.com/tylerflex) in #70
+- Logging, by [@tylerflex](https://github.com/tylerflex) in #70
 - Multi-pole Drude medium by [@weiliangjin2021](https://github.com/weiliangjin2021) in #73
 - Mode Solver: from [@tylerflex](https://github.com/tylerflex) in #74
 - Near2Far from [@tylerflex](https://github.com/tylerflex) in #77

docs/_static/css/custom.css

@@ -26,6 +26,8 @@ iframe {width: 100%;border: unset}
 
 .toctree-wrapper li[class^=toctree-l1]>a {font-size: 1.4em; text-decoration: none}
 .toctree-wrapper li[class^=toctree-l2]>a {font-size: 1em; text-decoration: none}
+.toctree-wrapper li[class^=toctree-l3]>a {font-size: 0.9em; text-decoration: none}
+.toctree-wrapper li[class^=toctree-l4]>a {font-size: 0.9em; text-decoration: none}
 
 html[data-theme="light"] {
     --pst-color-primary: #b5445b;
@@ -79,6 +81,10 @@ img {
     background-color: var(--sd-color-info-bg);
 }
 
+html[data-theme=dark] .dataframe {
+    background-color: var(--pst-color-primary);
+}
+
 /* TODO make sure this is only for the API tables */
 /*table {*/
 /*  border: solid;*/

docs/api/index.rst

@@ -1,6 +1,6 @@
-***
-API
-***
+***************
+API |:computer:|
+***************
 
 .. toctree::
     :hidden:

docs/api/plugins/design.rst

@@ -3,6 +3,8 @@
 Design Space Exploration
 ------------------------
 
+.. mdinclude:: ../../tidy3d/plugins/design/README.md
+
 .. autosummary::
    :toctree: ../_autosummary/
    :template: module.rst

docs/changelog.rst

@@ -1,4 +1,5 @@
-Changelog
-=========
+********************
+Changelog |:rewind:|
+********************
 
-.. mdinclude:: ../../CHANGELOG.md
+.. mdinclude:: ../CHANGELOG.md

docs/conf.py

@@ -80,6 +80,7 @@
     "IPython.sphinxext.ipython_directive",
     "IPython.sphinxext.ipython_console_highlighting",
     "nbsphinx",  # Integrate Jupyter Notebooks and Sphinx
+    "m2r2",
     # "sphinxcontrib.divparams", # TODO FIX
     "sphinx.ext.autodoc",  # Core Sphinx library for auto html doc generation from docstrings
     "sphinx.ext.autosummary",  # Create neat summary tables for modules/classes/methods etc

docs/development/index.rst

@@ -1,6 +1,6 @@
-*****************
-Development Guide
-*****************
+********************************************************************
+Development Guide |:hammer_and_wrench:|
+********************************************************************
 
 Welecome to the ``tidy3d`` developers guide! These are just some recommendations I've compiled, but we can change anything as we think might help the development cycle more.