Skip to content

Comments

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

Merged
Xuanwo merged 5 commits intomainfrom
cpp-doxygen
Sep 1, 2023
Merged

docs(bindings/cpp): use doxygen to generate API docs#2988
Xuanwo merged 5 commits intomainfrom
cpp-doxygen

Conversation

@silver-ymz
Copy link
Member

No description provided.

@github-actions github-actions bot added the releases-note/docs The PR modifies docs related content or has a title that begins with "docs" label Aug 31, 2023
@silver-ymz
Copy link
Member Author

silver-ymz commented Aug 31, 2023

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?

Signed-off-by: silver-ymz <[email protected]>
@Xuanwo
Copy link
Member

Xuanwo commented Aug 31, 2023

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
Copy link
Member Author

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
Copy link
Member

Xuanwo commented Aug 31, 2023

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
Copy link
Member Author

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

Signed-off-by: silver-ymz <[email protected]>
Signed-off-by: silver-ymz <[email protected]>
@Xuanwo Xuanwo merged commit 61fbf0c into main Sep 1, 2023
@Xuanwo Xuanwo deleted the cpp-doxygen branch September 1, 2023 02:53
@Xuanwo
Copy link
Member

Xuanwo commented Sep 1, 2023

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
Copy link
Member Author

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
Copy link
Member

Xuanwo commented Sep 1, 2023

Thanks a lot!

@silver-ymz silver-ymz mentioned this pull request Sep 1, 2023
8 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

releases-note/docs The PR modifies docs related content or has a title that begins with "docs"

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants