Repository navigation
[Doc] Migrate C++ and Python client API docs generate process #17917
Description
Search before asking
- I searched in the issues and found nothing similar.
What issue do you find in Pulsar docs?
After #17724 moves pulsar-client-cpp and pulsar-client-python to new repository, the original doxygen-doc-gen.sh and pdoc generation process can break.
What is your suggestion?
We should investigate them and migrate if necessary.
The Python part should be done by:
Any reference?
@urfreespace @SignorMercurio @michaeljmarshall please take a look.
Are you willing to submit a PR?
- I'm willing to submit a PR!
Reacted by Mercurio
Reacted by Anonymitaet
Activity
Mini256 commentedon Oct 25, 2022
When I installed the pulsar client according to the documentation, I found that the pulsar-client-cpp has been migrated, will this issue be used to track the issue of updating the repo link in the documentation?
https://pulsar.apache.org/docs/client-libraries-cpp/
tisonkun commentedon Oct 25, 2022
@Mini256 I think in this PR #18140 we already update references of the C++/Python clients' repo. Do you spot any reference unexpected? Or do you think we should add more references at the beginning?
Please share more details you'd like to achieve here :)
Mini256 commentedon Oct 25, 2022
https://pulsar.apache.org/docs/client-libraries-cpp#macos
The first step for MacOS tells me that:
And when I execute the
cmakecommand, I found that the code of the client has been migrated.tisonkun commentedon Oct 25, 2022
@Mini256 Good point. In the next version, we change this section directly to the new repo's README. Let me cherry-pick to to other maintained versions.
michaeljmarshall commentedon Oct 28, 2022
Where should we move the python doc process? It's in the pulsar-site right now. I think we could leave the process there and just update the relevant release process docs so that the release manager knows how to generate the docs.
tisonkun commentedon Nov 11, 2022
@michaeljmarshall agree and file #18347. I'm doing this now.