[PATCH v15 5/5] dts: add API doc generation

[Thomas Monjalon]

06/08/2024 17:19, Juraj Linkeš:
> +"""Utilities for DTS dependencies.
> +
> +The module can be used as an executable script,
> +which verifies that the running Python version meets the version requirement of DTS.
> +The script returns the standard exit codes in this mode (0 is success, 1 is failure).

Is it returning the list of dependencies for generating doc?

> +
> +The module also contains a function, get_missing_imports,
> +which looks for runtime and doc generation dependencies in the DTS pyproject.toml file
> +a returns a list of module names used in an import statement that are missing.

typo? a -> and

[...]
> +get_dts_deps = py3 + files('get-dts-deps.py')

deps for runtime or doc?
may be good to specify in the name


> --- /dev/null
> +++ b/doc/api/dts/custom.css
> @@ -0,0 +1 @@
> +../../guides/custom.css
> \ No newline at end of file

Is it a link? Why?

> +htmldir = join_paths(get_option('datadir'), 'doc', 'dpdk', 'dts')
> +dts_api_html = custom_target('dts_api_html',
> +        output: 'html',
> +        command: [sphinx_wrapper, sphinx, meson.project_version(),
> +            meson.current_source_dir(), meson.current_build_dir(), extra_sphinx_args],
> +        build_by_default: get_option('enable_docs'),
> +        install: get_option('enable_docs'),
> +        install_dir: htmldir)

When custom.css is copied?



> +# Napoleon enables the Google format of Python doscstrings, used in DTS.
> +# Intersphinx allows linking to external projects, such as Python docs, also used in DTS.
> +extensions = ['sphinx.ext.napoleon', 'sphinx.ext.intersphinx']

What happens if napoleon and intersphinx are not available
when building basic DPDK doc without DTS?