Sphinx and doxygen documentation support

analogdevicesinc / precision-converters-firmware

Precision Converters Embedded Firmware Repository

https://analogdevicesinc.github.io/precision-converters-firmware/

Apache License 2.0

16 stars 18 forks source link

Sphinx and doxygen documentation support #44

Closed mphalke closed 7 months ago

mphalke commented 10 months ago

doc: Adding initial set of sphinx documentation Added initial set of sphinx documentation targeting the ad4130 IIO firmware
doc: Added documentation for ad7606, ad7689, ad7768-1, ad738x and ad7124-temperature-measure projects Added sphinx documentation and updated TOC using index.rst files
Added github workflow for building documentation
doc: Added doxygen support

mphalke commented 10 months ago

Last 4 commits can be reviewed as first one is already reviewed through internal repo

SaikiranGudla commented 10 months ago

One general comment: Is it a good idea to add the documentation link in the About section of the repo, just like in the no-os repository?

mphalke commented 10 months ago

One general comment: Is it a good idea to add the documentation link in the About section of the repo, just like in the no-os repository?

Can you point me towards this? I will have a look

SaikiranGudla commented 10 months ago

One general comment: Is it a good idea to add the documentation link in the About section of the repo, just like in the no-os repository?

Can you point me towards this? I will have a look

Yes, in this way, which appears in the About section

mphalke commented 10 months ago

One general comment: Is it a good idea to add the documentation link in the About section of the repo, just like in the no-os repository?

Can you point me towards this? I will have a look

Yes, in this way, which appears in the About section

good idea. I think this just need updates to About text of repo and can be done once all documentation is migrated. We should not point towards incomplete documentation. Another suggestion is to keep this branch open and use it just for documentation updates and once everything is migrated merge to main branch (of course with fetching latest changes and resolving merger conflicts).

gastmaier commented 8 months ago

Hi, forked this branch to use ADI Doctools see here live preview ci run

SaikiranGudla commented 7 months ago

Changelog: Squashed 24 commits to 14 commits

SaikiranGudla commented 7 months ago

Change log: Reduced maxdepth in fw apps index toc to 1 from 2

SaikiranGudla commented 7 months ago

Hi @jansunil, @CMinajigi, is this good to go?