[PATCH] dts: remove optional docs dependencies

[PATCH] dts: remove optional docs dependencies

[Luca Vizzarro]

The CI currently does not support the optional DTS docs dependencies. As
a consequence, all of the public docs are always built and deployed without
them.

To simplify the maintenance process, remove the optional docs dependencies
and abandon support.

Signed-off-by: Luca Vizzarro <luca.vizzarro@arm.com>
---
 doc/guides/conf.py       | 7 -------
 doc/guides/tools/dts.rst | 5 -----
 dts/pyproject.toml       | 9 ---------
 3 files changed, 21 deletions(-)

diff --git a/doc/guides/conf.py b/doc/guides/conf.py
index 4b1059c202..2c1aa81bbf 100644
--- a/doc/guides/conf.py
+++ b/doc/guides/conf.py
@@ -65,13 +65,6 @@
         graphviz_output_format = "svg"
         tags.add("graphviz")
 
-    # Pydantic models require autodoc_pydantic for the right formatting. Add if installed.
-    try:
-        import sphinxcontrib.autodoc_pydantic
-        extensions.append("sphinxcontrib.autodoc_pydantic")
-    except ImportError:
-        pass
-
     # Napoleon enables the Google format of Python doscstrings.
     napoleon_numpy_docstring = False
     napoleon_attr_annotations = True
diff --git a/doc/guides/tools/dts.rst b/doc/guides/tools/dts.rst
index 78761dc49e..3837b398cf 100644
--- a/doc/guides/tools/dts.rst
+++ b/doc/guides/tools/dts.rst
@@ -491,11 +491,6 @@ Building DTS API docs
 The documentation is built using the standard DPDK build system.
 See :doc:`../linux_gsg/build_dpdk` for more details on compiling DPDK with meson.
 
-.. code-block:: console
-
-   poetry install --only docs
-   poetry install --with docs  # an alternative that will also install DTS dependencies
-
 After executing the meson command, build the documentation with:
 
 .. code-block:: console
diff --git a/dts/pyproject.toml b/dts/pyproject.toml
index 8df0a894dc..8b061c3cee 100644
--- a/dts/pyproject.toml
+++ b/dts/pyproject.toml
@@ -35,15 +35,6 @@ types-paramiko = "^3.5.0.20240928"
 types-invoke = "^2.0.0.10"
 types-pyyaml = "^6.0.12.20240917"
 
-[tool.poetry.group.docs]
-optional = true
-
-[tool.poetry.group.docs.dependencies]
-sphinx = "<=7"
-sphinx-rtd-theme = ">=1.2.2"
-pyelftools = "^0.31"
-autodoc-pydantic = "^2.2.0"
-
 [build-system]
 requires = ["poetry-core>=1.0.0"]
 build-backend = "poetry.core.masonry.api"
-- 
2.43.0

Re: [PATCH] dts: remove optional docs dependencies

[Patrick Robb]

[-- Attachment #1: Type: text/plain, Size: 2702 bytes --]

Thanks. Confirming for the mailing list that we discussed this at the DTS
meeting last week and agreed on this course of action.

Reviewed-by: Patrick Robb <probb@iol.unh.edu>

On Fri, Aug 1, 2025 at 7:45 AM Luca Vizzarro <luca.vizzarro@arm.com> wrote:

> The CI currently does not support the optional DTS docs dependencies. As
> a consequence, all of the public docs are always built and deployed without
> them.
>
> To simplify the maintenance process, remove the optional docs dependencies
> and abandon support.
>
> Signed-off-by: Luca Vizzarro <luca.vizzarro@arm.com>
> ---
>  doc/guides/conf.py       | 7 -------
>  doc/guides/tools/dts.rst | 5 -----
>  dts/pyproject.toml       | 9 ---------
>  3 files changed, 21 deletions(-)
>
> diff --git a/doc/guides/conf.py b/doc/guides/conf.py
> index 4b1059c202..2c1aa81bbf 100644
> --- a/doc/guides/conf.py
> +++ b/doc/guides/conf.py
> @@ -65,13 +65,6 @@
>          graphviz_output_format = "svg"
>          tags.add("graphviz")
>
> -    # Pydantic models require autodoc_pydantic for the right formatting.
> Add if installed.
> -    try:
> -        import sphinxcontrib.autodoc_pydantic
> -        extensions.append("sphinxcontrib.autodoc_pydantic")
> -    except ImportError:
> -        pass
> -
>      # Napoleon enables the Google format of Python doscstrings.
>      napoleon_numpy_docstring = False
>      napoleon_attr_annotations = True
> diff --git a/doc/guides/tools/dts.rst b/doc/guides/tools/dts.rst
> index 78761dc49e..3837b398cf 100644
> --- a/doc/guides/tools/dts.rst
> +++ b/doc/guides/tools/dts.rst
> @@ -491,11 +491,6 @@ Building DTS API docs
>  The documentation is built using the standard DPDK build system.
>  See :doc:`../linux_gsg/build_dpdk` for more details on compiling DPDK
> with meson.
>
> -.. code-block:: console
> -
> -   poetry install --only docs
> -   poetry install --with docs  # an alternative that will also install
> DTS dependencies
> -
>  After executing the meson command, build the documentation with:
>
>  .. code-block:: console
> diff --git a/dts/pyproject.toml b/dts/pyproject.toml
> index 8df0a894dc..8b061c3cee 100644
> --- a/dts/pyproject.toml
> +++ b/dts/pyproject.toml
> @@ -35,15 +35,6 @@ types-paramiko = "^3.5.0.20240928"
>  types-invoke = "^2.0.0.10"
>  types-pyyaml = "^6.0.12.20240917"
>
> -[tool.poetry.group.docs]
> -optional = true
> -
> -[tool.poetry.group.docs.dependencies]
> -sphinx = "<=7"
> -sphinx-rtd-theme = ">=1.2.2"
> -pyelftools = "^0.31"
> -autodoc-pydantic = "^2.2.0"
> -
>  [build-system]
>  requires = ["poetry-core>=1.0.0"]
>  build-backend = "poetry.core.masonry.api"
> --
> 2.43.0
>
>

[-- Attachment #2: Type: text/html, Size: 3463 bytes --]