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

Juraj Linkeš juraj.linkes at pantheon.tech
Mon Aug 12 10:08:14 CEST 2024



> <snip>
>> --- /dev/null
>> +++ b/doc/api/dts/meson.build
>> @@ -0,0 +1,29 @@
>> +# SPDX-License-Identifier: BSD-3-Clause
>> +# Copyright(c) 2023 PANTHEON.tech s.r.o.
> 
> Should this be 2023 or updated now that we're in 2024? Probably
> doesn't matter too much either way.
> 

I've talked to Thomas about copyrights and in essence, the copyright is 
going to be valid for a long time, so basically there's no need.


>> diff --git a/doc/api/meson.build b/doc/api/meson.build
>> index 5b50692df9..788129336b 100644
>> --- a/doc/api/meson.build
>> +++ b/doc/api/meson.build
>> @@ -1,6 +1,18 @@
>>   # SPDX-License-Identifier: BSD-3-Clause
>>   # Copyright(c) 2018 Luca Boccassi <bluca at debian.org>
>>
> 
> Should you add your copyright to the top of this file now that you've
> also modified it?
> 

Possibly, but I actually want to move almost all (or maybe all of if it 
works) of this one level deeper, so that would make too small of a 
change to warrant the inclusion of you copyright I think.

>> +dts_doc_targets = []
>> +dts_doc_target_names = []
>> +subdir('dts')
>> +
>> +if dts_doc_targets.length() == 0
>> +    dts_message = 'No DTS docs targets found'
>> +else
>> +    dts_message = 'Building DTS docs:'
>> +endif
>> +run_target('dts-doc', command: [echo, dts_message, dts_doc_target_names],
>> +    depends: dts_doc_targets)
>> +
>>   doxygen = find_program('doxygen', required: get_option('enable_docs'))
>>
>>   if not doxygen.found()
>> @@ -40,6 +52,7 @@ cdata.set('WARN_AS_ERROR', 'NO')
>>   if get_option('werror')
>>       cdata.set('WARN_AS_ERROR', 'YES')
>>   endif
>> +cdata.set('DTS_API_MAIN_PAGE', join_paths('..', 'dts', 'html', 'index.html'))
>>
>>   # configure HTML Doxygen run
>>   html_cdata = configuration_data()
>> diff --git a/doc/guides/conf.py b/doc/guides/conf.py
>> index 0f7ff5282d..d7f3030838 100644
>> --- a/doc/guides/conf.py
> <snip>
>>


More information about the dev mailing list