chore(deps): update documentation dependencies to latest versions and add pydantic to enable builds to pass (#545)

* chore(deps): update documentation dependencies to latest versions and add pydantic to enable builds to pass

* chore: remove post_install job from Read the Docs configuration

Author: nfelt14

.readthedocs.yml

@@ -5,8 +5,6 @@ build:
   tools:
     python: '3.11'  # This needs to stay in sync with the tox config in pyproject.toml and any CI scripts
     nodejs: '22'  # This needs to stay in sync with any CI scripts
-  jobs:
-    post_install: [python scripts/install_insiders_packages.py]
 python:
   install:
     - requirements: docs/requirements.txt

docs/_templates/mkdocstrings/python/readthedocs/class.html.jinja

@@ -192,7 +192,7 @@ Create and read from a dynamic buffer.
 Sometimes using the [`DeviceManager`][tm_devices.DeviceManager] class as a context manager is not feasible.
 In those instances there is an alternative way to enforce the device manager to
 close when the Python script execution is finished without needing to explicitly
-call the [`.close()`][tm_devices.DeviceManager.close] method.
+call the [`.close()`][tm_devices.device_manager.DeviceManager.close] method.
 
 ```python
 # fmt: off

docs/basic_usage.md

@@ -1,3 +1,4 @@
+annotated-types==0.7.0 ; python_version >= "3.10" and python_version < "3.15"
 beautifulsoup4==4.14.3 ; python_version >= "3.10" and python_version < "3.15"
 black==26.1.0 ; python_version >= "3.10" and python_version < "3.15"
 bracex==2.6 ; python_version >= "3.10" and python_version < "3.15"
@@ -29,14 +30,16 @@ mkdocs-macros-plugin==1.5.0 ; python_version >= "3.10" and python_version < "3.1
 mkdocs-mermaid2-plugin==1.2.3 ; python_version >= "3.10" and python_version < "3.15"
 mkdocs-section-index==0.3.10 ; python_version >= "3.10" and python_version < "3.15"
 mkdocs-spellcheck==1.2.0 ; python_version >= "3.10" and python_version < "3.15"
-mkdocstrings==0.30.1 ; python_version >= "3.10" and python_version < "3.15"
-mkdocstrings-python==1.19.0 ; python_version >= "3.10" and python_version < "3.15"
+mkdocstrings==1.0.2 ; python_version >= "3.10" and python_version < "3.15"
+mkdocstrings-python==2.0.1 ; python_version >= "3.10" and python_version < "3.15"
 more-itertools==10.8.0 ; python_version >= "3.10" and python_version < "3.15"
 mypy-extensions==1.1.0 ; python_version >= "3.10" and python_version < "3.15"
 nodeenv==1.10.0 ; python_version >= "3.10" and python_version < "3.15"
 packaging==26.0 ; python_version >= "3.10" and python_version < "3.15"
 pathspec==1.0.4 ; python_version >= "3.10" and python_version < "3.15"
 platformdirs==4.5.1 ; python_version >= "3.10" and python_version < "3.15"
+pydantic==2.12.5 ; python_version >= "3.10" and python_version < "3.15"
+pydantic-core==2.41.5 ; python_version >= "3.10" and python_version < "3.15"
 pygments==2.19.2 ; python_version >= "3.10" and python_version < "3.15"
 pymdown-extensions==10.20.1 ; python_version >= "3.10" and python_version < "3.15"
 python-dateutil==2.9.0.post0 ; python_version >= "3.10" and python_version < "3.15"
@@ -53,6 +56,7 @@ termcolor==3.3.0 ; python_version >= "3.10" and python_version < "3.15"
 tomli==2.4.0 ; python_version >= "3.10" and python_version < "3.15"
 typeguard==4.4.4 ; python_version >= "3.10" and python_version < "3.15"
 typing-extensions==4.15.0 ; python_version >= "3.10" and python_version < "3.15"
+typing-inspection==0.4.2 ; python_version >= "3.10" and python_version < "3.15"
 urllib3==2.6.3 ; python_version >= "3.10" and python_version < "3.15"
 watchdog==6.0.0 ; python_version >= "3.10" and python_version < "3.15"
 wcmatch==10.1 ; python_version >= "3.10" and python_version < "3.15"

docs/requirements.txt

@@ -103,7 +103,8 @@ plugins:
           options:
             # General options
             extensions: [docs/griffe_custom_decorator_labels.py]
-            show_inheritance_diagram: true  # INSIDERS FEATURE
+            inheritance_diagram_direction: LR
+            show_inheritance_diagram: true
             show_source: false  # a link is included at the top of each page
             # Headings options
             heading_level: 1
@@ -124,16 +125,16 @@ plugins:
               trim_doctest_flags: true
             docstring_section_style: list
             merge_init_into_class: true
-            relative_crossrefs: true  # INSIDERS FEATURE
-            scoped_crossrefs: true  # INSIDERS FEATURE
+            relative_crossrefs: true
+            scoped_crossrefs: true
             # Signature options
             line_length: 100
-            modernize_annotations: false  # INSIDERS FEATURE (if the source code annotations format changes, update this to true)
+            modernize_annotations: true
             show_signature_annotations: true
             signature_crossrefs: true
             separate_signature: true
             unwrap_annotated: true
-          import:
+          inventories:
             - url: https://docs.python.org/3/objects.inv
               domains: [std, py]
             - url: https://typing-extensions.readthedocs.io/en/stable/objects.inv

mkdocs.yml

@@ -128,20 +128,21 @@ wheel = "^0.46.2"
 [tool.poetry.group.docs.dependencies]
 black = "^26.1.0"
 codespell = "^2.2.6"
-griffe = "^1.1.0"
-mkdocs = "^1.6.0"
-mkdocs-ezglossary-plugin = "^2.0.0"
+griffe = "^1.15.0"
+mkdocs = "^1.6.1"
+mkdocs-ezglossary-plugin = "^2.1.0"
 mkdocs-gen-files = "^0.6.0"
-mkdocs-include-markdown-plugin = "^7.1.5"
-mkdocs-literate-nav = "^0.6.1"
-mkdocs-macros-plugin = "^1.0.5"
-mkdocs-mermaid2-plugin = "^1.1.1"
-mkdocs-section-index = "^0.3.9"
-mkdocs-spellcheck = "^1.1.0"
-mkdocstrings = "^0.30.0"
-mkdocstrings-python = "^1.10.2"
+mkdocs-include-markdown-plugin = "^7.2.1"
+mkdocs-literate-nav = "^0.6.2"
+mkdocs-macros-plugin = "^1.5.0"
+mkdocs-mermaid2-plugin = "^1.2.3"
+mkdocs-section-index = "^0.3.10"
+mkdocs-spellcheck = "^1.2.0"
+mkdocstrings = "^1.0.2"
+mkdocstrings-python = "^2.0.1"
 nodeenv = "^1.9.1"
 packaging = ">=24.0"
+pydantic = "^2.12.5"
 pygments = "^2.17.2"
 pymdown-extensions = "^10.8.1"
 requests = "^2.31.0"
@@ -472,27 +473,21 @@ commands_pre =
 
 [testenv:docs]
 basepython = {env:DOC_PYTHON_VERSION}
-passenv =
-    GITHUB_PAT
 deps =
     -rdocs/requirements.txt
 commands_pre =
     nodeenv --python-virtualenv --clean-src
-    python scripts/install_insiders_packages.py
 commands =
     python -c "import shutil; shutil.rmtree('.results_{envname}', ignore_errors=True)"
     mkdocs --verbose build --site-dir .results_{envname}
 
 [testenv:doctests]
 basepython = {env:DOC_PYTHON_VERSION}
-passenv =
-    GITHUB_PAT
 deps =
     -rdocs/requirements.txt
     -rtests/requirements.txt
 commands_pre =
     nodeenv --python-virtualenv --clean-src
-    python scripts/install_insiders_packages.py
 commands =
     pytest -v -k "test_docs" --showlocals --junitxml={tox_root}/.results_{envname}/results.xml --self-contained-html --html={tox_root}/.results_{envname}/results.html
 

pyproject.toml

@@ -118,9 +118,9 @@ def defined_config_file_path(self) -> str:
         """Filepath of the config file.
 
         Prioritizes the path contained in the environment variable defined by
-        [`DMConfigParser.CONFIG_FILE_PATH_ENV_VARIABLE`][tm_devices.components.DMConfigParser.CONFIG_FILE_PATH_ENV_VARIABLE]
+        [`DMConfigParser.CONFIG_FILE_PATH_ENV_VARIABLE`][tm_devices.components.dm_config_parser.DMConfigParser.CONFIG_FILE_PATH_ENV_VARIABLE]
         with a fallback to the default path defined by
-        [`DMConfigParser.DEFAULT_CONFIG_FILE_PATH`][tm_devices.components.DMConfigParser.DEFAULT_CONFIG_FILE_PATH].
+        [`DMConfigParser.DEFAULT_CONFIG_FILE_PATH`][tm_devices.components.dm_config_parser.DMConfigParser.DEFAULT_CONFIG_FILE_PATH].
         """
         return os.getenv(
             self.CONFIG_FILE_PATH_ENV_VARIABLE,
@@ -304,7 +304,7 @@ def write_config_to_file(self, config_file_path: str | os.PathLike[str] | None =
 
         This method will overwrite any existing config file with the current devices and options. If
         no custom path is provided, it will write to the file defined by
-        [`DMConfigParser.defined_config_file_path`][tm_devices.components.DMConfigParser.defined_config_file_path].
+        [`DMConfigParser.defined_config_file_path`][tm_devices.components.dm_config_parser.DMConfigParser.defined_config_file_path].
 
         Args:
             config_file_path: The path to the config file. If ends in ".toml" will create toml file.