🔧 Fix docs build with some upgrades

daquintero · Jul 29, 2024 · 350527c · 350527c
1 parent ae1fc1e
commit 350527c
Show file tree

Hide file tree

Showing 10 changed files with 87 additions and 18 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -72,6 +72,7 @@
     "sphinx_autodoc_typehints",  # Automatically document param types (less noise in class signature)
     "sphinx_gallery.load_style",
     "sphinx-pydantic",
+    "versionwarning.extension",
 ]
 
 # Grouping the document tree into LaTeX files. List of tuples
@@ -138,3 +139,12 @@
     #
     # 'figure_align': 'htbp',
 }
+
+versionwarning_admonition_type = "tip"
+versionwarning_messages = {
+    'latest': 'You are reading the "latest" pip-unreleased version of this documentation.'
+              ' See the stable branch for the latest release.',
+}
+versionwarning_admonition_type = 'tip'
+versionwarning_banner_title = 'Tip'
+versionwarning_body_selector = 'div[itemprop="articleBody"]'
diff --git a/docs/examples.rst b/docs/examples.rst
@@ -19,4 +19,5 @@ Examples
    examples/06_component_codesign_basics
    examples/06a_analytical_mzm_model
    examples/07_mixed_signal_photonic_cosimulation
-   examples/08_basic_interconnection_modelling
+   examples/08_basic_interconnection_modelling/08_basic_interconnection_modelling
+   examples/08a_pcb_interposer_characterisation/08a_pcb_interposer_characterisation
diff --git a/docs/index.rst b/docs/index.rst
@@ -11,9 +11,9 @@ Contents
 
    examples
    sections/environment/index
-   sections/microservices/index
    sections/codesign/index
    sections/models/index
+   sections/microservices/index
    resources/index
    contributing
    sections/about/index

diff --git a/docs/resources/fsic_2024_presentation/index.rst b/docs/resources/fsic_2024_presentation/index.rst
@@ -6,6 +6,15 @@ This page involves the outline and resources related to of the presentation: *In
 Presentation
 ^^^^^^^^^^^^
 
+You can listen to the presentation here:
+
+.. raw:: html
+
+    <iframe title="Integrating Mixed-Signal Microelectronics and Photonics: A Co-Design Approach with Piel, Dario Quintero, PIEL" width="560" height="315" src="https://peertube6.f-si.org/videos/embed/68afd3f0-19d8-47ac-841c-caa9c07d31ce" frameborder="0" allowfullscreen="" sandbox="allow-same-origin allow-scripts allow-popups allow-forms"></iframe>
+
+
+You can also see the slides here:
+
 :pdfembed:`src:../../_static/resources/fsic_2024_presentation.pdf, height:480px, width:100%, align:middle`
 
 Outline

diff --git a/docs/sections/microservices/index.rst b/docs/sections/microservices/index.rst
@@ -17,17 +17,18 @@ Project Structure
 
 A general overview of the ``piel`` python package structure:
 
-```raw
-piel/
-    cli/ # command-line scripts
-    experimental/ # selected set of functions useful when interacting with relevant equipment
-    flows/ # High-level user-specific functionality to automate common design tasks
-    integration/ # Deterministic explicit functionality between toolsets
-    materials/ # Self-contained or referenced material models
-    models/ # Specific instances, or target application usages, operate on other directories
-    tools/ # Relevant extended functionality onto supported tools
-    visual/ # Utilities to plot and visualise relationships
-```
+.. raw::
+
+    piel/
+        cli/ # command-line scripts
+        experimental/ # selected set of functions useful when interacting with relevant equipment
+        flows/ # High-level user-specific functionality to automate common design tasks
+        integration/ # Deterministic explicit functionality between toolsets
+        materials/ # Self-contained or referenced material models
+        models/ # Specific instances, or target application usages, operate on other directories
+        tools/ # Relevant extended functionality onto supported tools
+        visual/ # Utilities to plot and visualise relationships
+
 
 
 .. toctree::

diff --git a/docs/sections/models/index.rst b/docs/sections/models/index.rst
@@ -1,12 +1,45 @@
 **************************
-Models
+Data Structures
 **************************
 
+Types
+=====
+
+``piel`` is built on top of the popular python package `pydantic <https://docs.pydantic.dev/latest/>`_.
+All ``piel.types`` are defined as static ``pydantic.BaseClass`` subclasses. The goal is to enable purely functional
+data containers and operations. This enables extensibility when using common data types between multiple tools or workflows.
+By translating the data from multiple tools into standard types, we guarantee that the functionality developed on top
+of this data type can be validated, verified and extensibly used at a higher-level without worrying of the lower-level implementation.
+
+
+Note that there are both standard types and experimental types according to the functionality required:
+
+.. toctree::
+    :maxdepth: 2
+
+    ../../autoapi/piel/types/index.rst
+
+
+Experimental
+-------------
+
+There are some `experimental-specific` data types, where functionality integrating common devices into the standard ``piel`` data types is described. See the related examples too. TODO link.
+
+.. toctree::
+    :maxdepth: 2
+
+    ../../autoapi/piel/experimental/types/index.rst
+
+
+Models
+======
+
 `piel` provides a component model library to aid co-simulation. However, to extract a range of system performance parameters, simulations often tend to have to be done in different domains. This is why we need to have models that represent the same component, in different domains.
 
 .. include:: domains.rst
 .. include:: time_domain.rst
 .. include:: spice_integration.rst
 
 .. toctree::
+    :maxdepth: 2
     ../../autoapi/piel/models/index.rst
diff --git a/piel/experimental/types/measurements/__init__.py b/piel/experimental/types/measurements/__init__.py
diff --git a/piel/experimental/types/measurements/propagation.py b/piel/experimental/types/measurements/propagation.py
@@ -1,5 +1,4 @@
-from typing import Optional
-from ....types import Instance, PathTypes, PielBaseModel
+from ....types import Instance, PathTypes
 from ..device import DeviceMeasurement
 from ..experiment import ExperimentInstance
 

diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -94,6 +94,7 @@ sphinx-gallery = {version = "*", optional = true}
 sphinx-pydantic = {version = "*", optional = true}
 sphinx-rtd-theme = {version = "*", optional = true}
 sphinx_book_theme = {version = "*", optional = true}
+sphinx-version-warning = {version = "*", optional = true}
 sphinxcontrib-pdfembed = {git = "https://github.com/SuperKogito/sphinxcontrib-pdfembed.git", optional = true}
 thewalrus = "^0.20.0"
 tox = {version = "*", optional = true}
@@ -140,6 +141,7 @@ dev = [
   "sphinx-gallery",
   "sphinx-pydantic",
   "sphinx-rtd-theme",
+  "sphinx-version-warning",
   "sphinxcontrib-pdfembed",
   "tox",
   "watchdog"