Re: [PATCH v6 4/4] dts: add API doc generation

["Juraj Linkeš" <juraj.linkes@pantheon.tech>]

Hi Thomas,

I believe the only open question in this patch set is the linking of DTS 
API docs on the main doxygen page. I've left only the parts relevant to 
the question so that it's easier for us to address it.

> diff --git a/doc/api/doxy-api-index.md b/doc/api/doxy-api-index.md
> index f9283154f8..cc214ede46 100644
> --- a/doc/api/doxy-api-index.md
> +++ b/doc/api/doxy-api-index.md
> @@ -244,3 +244,6 @@ The public API headers are grouped by topics:
>     [experimental APIs](@ref rte_compat.h),
>     [ABI versioning](@ref rte_function_versioning.h),
>     [version](@ref rte_version.h)
> +
> +- **tests**:
> +  [**DTS**](@dts_api_main_page)

> diff --git a/doc/api/doxy-api.conf.in b/doc/api/doxy-api.conf.in
> index a8823c046f..c94f02d411 100644
> --- a/doc/api/doxy-api.conf.in
> +++ b/doc/api/doxy-api.conf.in
> @@ -124,6 +124,8 @@ SEARCHENGINE            = YES
>   SORT_MEMBER_DOCS        = NO
>   SOURCE_BROWSER          = YES
>   
> +ALIASES                 = "dts_api_main_page=@DTS_API_MAIN_PAGE@"
> +
>   EXAMPLE_PATH            = @TOPDIR@/examples
>   EXAMPLE_PATTERNS        = *.c
>   EXAMPLE_RECURSIVE       = YES

> diff --git a/doc/api/meson.build b/doc/api/meson.build
> index 5b50692df9..ffc75d7b5a 100644
> --- a/doc/api/meson.build
> +++ b/doc/api/meson.build

> @@ -32,14 +33,18 @@ example = custom_target('examples.dox',
>   # set up common Doxygen configuration
>   cdata = configuration_data()
>   cdata.set('VERSION', meson.project_version())
> -cdata.set('API_EXAMPLES', join_paths(dpdk_build_root, 'doc', 'api', 'examples.dox'))
> -cdata.set('OUTPUT', join_paths(dpdk_build_root, 'doc', 'api'))
> +cdata.set('API_EXAMPLES', join_paths(doc_api_build_dir, 'examples.dox'))
> +cdata.set('OUTPUT', doc_api_build_dir)
>   cdata.set('TOPDIR', dpdk_source_root)
> -cdata.set('STRIP_FROM_PATH', ' '.join([dpdk_source_root, join_paths(dpdk_build_root, 'doc', 'api')]))
> +cdata.set('STRIP_FROM_PATH', ' '.join([dpdk_source_root, doc_api_build_dir]))

These three changes are here only for context, they're not relevant to 
the linking question.

>   cdata.set('WARN_AS_ERROR', 'NO')
>   if get_option('werror')
>       cdata.set('WARN_AS_ERROR', 'YES')
>   endif
> +# A local reference must be relative to the main index.html page
> +# The path below can't be taken from the DTS meson file as that would
> +# require recursive subdir traversal (doc, dts, then doc again)
> +cdata.set('DTS_API_MAIN_PAGE', join_paths('..', 'dts', 'html', 'index.html'))

This is where the path is actually set.