docs(bindings/cpp): use doxygen to generate API docs

[silver-ymz]

No description provided.

[silver-ymz]

I use Doxygen Awesome to beautify the document generated by doxygen. I directly put its css file under docs dir. The css file has MIT license header. Could we add it to licenserc.toml?

[Xuanwo]

I use Doxygen Awesome to beautify the document generated by doxygen. I directly put its css file under docs dir. The css file has MIT license header. Could we add it to licenserc.toml?

It's better not to include it in our repo directly. Can we install them by npm during docs building?

[silver-ymz]

Can we install them by npm during docs building?

We can use other way to install them like npm or FetchContent in cmake. But this will make doc generating process become much complex. We just need single file of the repo, so I think it's a better way to just copy one file under our repo. Furthermore, I find that other repos also use this way, like wxWidgets, opencv 5.x.

[Xuanwo]

We just need single file of the repo, so I think it's a better way to just copy one file under our repo.

No, not a good way from releases side.

Furthermore, I find that other repos also use this way, like wxWidgets, opencv 5.x.

None of them are ASF projects. Although there are ways to declare an extra license for our repository, we should still avoid including content in this manner as it would complicate our release process.

We can use other way to install them like npm or FetchContent in cmake.

I prefer to use the npm way mentioned in their README:

cd your-project
npm install https://github.com/jothepro/doxygen-awesome-css#v2.2.1 --save-dev

ls -l node_module/@jothepro/doxygen-awesome-css

[silver-ymz]

I move awesome-doxygen to build process. Cmake will download it to build dir first, rather than try finding it in docs dir.

[Xuanwo]

Would you like to add this theme for c binding too? And we should add actions to deploy them to opendal.apache.org.

[silver-ymz]

Would you like to add this theme for c binding too?

Yes. I'd like to do it.

And we should add actions to deploy them to opendal.apache.org.

I'm writing github actions about test and docs now.

[Xuanwo]

Thanks a lot!