[PATCH v17 3/5] dts: add doc generation dependencies
Jeremy Spewock
jspewock at iol.unh.edu
Wed Aug 14 20:50:08 CEST 2024
On Wed, Aug 14, 2024 at 11:05 AM Juraj Linkeš
<juraj.linkes at pantheon.tech> wrote:
>
> Sphinx imports every Python module (through the autodoc extension)
> when generating documentation from docstrings, meaning all DTS
> dependencies, including Python version, should be satisfied. This is not
> a hard requirement, as imports from dependencies may be mocked in the
> autodoc_mock_imports autodoc option.
> In case DTS developers want to use a Sphinx installation from their
> virtualenv, we provide an optional Poetry group for doc generation. The
> pyelftools package is there so that meson picks up the correct Python
> installation, as pyelftools is required by the build system.
>
> Signed-off-by: Juraj Linkeš <juraj.linkes at pantheon.tech>
Reviewed-by: Jeremy Spewock <jspewock at iol.unh.edu>
More information about the dev
mailing list