Resolve docs-build issues

Author: BrianMichell

docs/data_models/index.md

@@ -4,6 +4,6 @@ This section contains the data models for the MDIO format.
 
 ```{toctree}
 :maxdepth: 2
-version_0
-version_1
+v0
+v1
 ```

docs/tutorials/quickstart.ipynb

@@ -922,7 +922,7 @@
     "* Compare binary headers\n",
     "* Compare 100 random headers and traces\n",
     "\n",
-    "[segy-github]: https://github.com/TGSAI/segy"
+    "<!-- [segy-github]: https://github.com/TGSAI/segy -->"
    ]
   },
   {

noxfile.py

@@ -278,9 +278,11 @@ def docs_build(session: Session) -> None:
             "sphinx",
             "sphinx-click",
             "sphinx-copybutton",
+            "sphinx-design",
             "furo",
             "myst-nb",
             "linkify-it-py",
+            "pint",
         ],
     )
 
@@ -303,9 +305,11 @@ def docs(session: Session) -> None:
             "sphinx-autobuild",
             "sphinx-click",
             "sphinx-copybutton",
+            "sphinx-design",
             "furo",
             "myst-nb",
             "linkify-it-py",
+            "pint",
         ],
     )
 

pyproject.toml

@@ -31,6 +31,7 @@ dependencies = [
     "psutil (>=6.1.0,<7.0.0)",
     "pydantic (>=2.8.2,<3.0.0)",
     "pydantic-settings (>=2.4.0,<3.0.0)",
+    "autodoc-pydantic (>=2.2.0,<3.0.0)",
     "fsspec (>=2024.10.0)",
     "segy (>=0.4.0,<0.5.0)",
     "rich (>=13.9.4,<14.0.0)",
@@ -76,14 +77,17 @@ dev = [
     "pytest-dependency>=0.6.0,<0.7",
     "pyupgrade>=3.19.0,<4",
     "safety>=3.2.3,<4",
+    "sphinx>=8.1.3,<9",
     "sphinx-autobuild>=2024.10.3",
     "sphinx-click>=6.0.0,<7",
     "sphinx-copybutton>=0.5.2,<0.6",
+    "sphinxcontrib-packages>=1.2.0,<2",
+    "sphinx-design>=0.6.1,<0.7",
     "typeguard>=4.4.1,<5",
     "xdoctest[colors]>=1.2.0,<2",
-    "myst-parser>=3.0.1,<4",
+    "myst-parser>=4.0.0,<5",
     "Pygments>=2.18.0,<3",
-    "Sphinx>=7.4.7,<8",
+    "pint>=0.24.3,<0.25",
 ]
 
 [tool.uv]

src/mdio/converters/segy.py

@@ -211,7 +211,6 @@ def segy_to_mdio(  # noqa: C901
 
         >>> from mdio import segy_to_mdio
         >>>
-        >>>
         >>> segy_to_mdio(
         ...     segy_path="prefix1/file.segy",
         ...     mdio_path_or_buffer="prefix2/file.mdio",
@@ -287,8 +286,8 @@ def segy_to_mdio(  # noqa: C901
 
         In cases where the user does not know if the input has unwrapped
         channels but desires to store with wrapped channel index use:
-        >>>    grid_overrides={"AutoChannelWrap": True,
-                               "AutoChannelTraceQC":  1000000}
+        >>> grid_overrides={"AutoChannelWrap": True,
+        ...                "AutoChannelTraceQC":  1000000}
 
         For ingestion of pre-stack streamer data where the user needs to
         access/index *common-channel gathers* (single gun) then the following