Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add tools for generate C++ api doc #286

Merged
merged 6 commits into from
Nov 15, 2022
Merged

Conversation

tisonkun
Copy link
Member

@tisonkun tisonkun commented Nov 15, 2022

... and generate for 3.0.0 and 2.10.2 for testing.

You can review the first two commits and preview the result locally.

This refers to apache/pulsar#17918.
This closes apache/pulsar#17917.
This closes apache/pulsar#17498.
This closes apache/pulsar#12843.

Signed-off-by: tison <wander4096@gmail.com>
Signed-off-by: tison <wander4096@gmail.com>
Signed-off-by: tison <wander4096@gmail.com>
Signed-off-by: tison <wander4096@gmail.com>
Signed-off-by: tison <wander4096@gmail.com>
Signed-off-by: tison <wander4096@gmail.com>
@tisonkun
Copy link
Member Author

tisonkun commented Nov 15, 2022

Moving forward to do the following tasks:

  • regenerate the missing API docs
  • cleanup legacy scripts
  • remove SNAPSHOT files under the asf-site-next branch

The solution should be better than the current status. Review comments after merge is welcome.

@tisonkun tisonkun merged commit 966a642 into apache:main Nov 15, 2022
@tisonkun tisonkun deleted the apidoc-cpp branch November 15, 2022 07:59
@michaeljmarshall
Copy link
Member

Thanks @tisonkun! Great work!

@tisonkun
Copy link
Member Author

FWW, I think generated apidocs should gradually archive to asf-site-next branch so that we keep source code tidy.

For example, I generate legacy C++ API doc and Python API doc at:

But I don't have a clear idea on workflow to do this archive. We can do it manually for a while and find a proper way.

Generate docs under the main branch has two advantages:

  • Simple preview;
  • Release manager doesn't have to understand how to commit API docs to the asf-site-next branch.

@michaeljmarshall
Copy link
Member

That approach makes sense to me.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants