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.

Sign up for GitHub

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

Jump to bottom

[Improvement] Support generating pydoc from client-python code #3824

Closed
jerryshao opened this issue Jun 8, 2024 · 2 comments · Fixed by #3839
Closed

[Improvement] Support generating pydoc from client-python code #3824

jerryshao opened this issue Jun 8, 2024 · 2 comments · Fixed by #3839
Assignees
@noidname01
Labels
0.6.0 Release v0.6.0 help wanted Extra attention is needed improvement Improvements on everything

Comments

@jerryshao
Copy link
Collaborator

What would you like to be improved?

We would like to generate pydoc from client-python code, and can be deployed on to the website.

How should we improve?

Add gradle build command to support generating pydoc from code.
@jerryshao jerryshao added help wanted Extra attention is needed improvement Improvements on everything labels Jun 8, 2024
@noidname01
Copy link
Contributor

Hi @jerryshao, I would like to work on this. Can you assign this issue to me?

@jerryshao
Copy link
Collaborator Author

Sure, no problem.

@noidname01 noidname01 mentioned this issue Jun 11, 2024
Merged
@jerryshao jerryshao added the 0.6.0 Release v0.6.0 label Jun 13, 2024
shaofengshi pushed a commit to shaofengshi/gravitino that referenced this issue Jun 24, 2024
@noidname01 @shaofengshi
[datastrato#3824] improvement(client-python): Support generating pydo…
f324852 
…c from client-python code (datastrato#3839)

### What changes were proposed in this pull request?

* Use `pydoc` to generate docs
* Add Gradle task `doc` to generate docs (it will create a `docs` folder
and generate all doc html files in it)

Screenshots of generated htmls:
* gravitino.html
<img width="1469" alt="image"
src="https://github.com/datastrato/gravitino/assets/55401762/42ee9484-0677-407c-b9d9-778fc4a870f7">

* gravitino.api.fileset.html
<img width="1459" alt="image"
src="https://github.com/datastrato/gravitino/assets/55401762/5856203a-0d79-4a65-b509-8171ce3c1aa8">


### Why are the changes needed?

Fix: datastrato#3824 

### Does this PR introduce _any_ user-facing change?

No

### How was this patch tested?

`./gradlew clients:client-python:test`

---------

Co-authored-by: TimWang <tim.wang@pranaq.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@noidname01 noidname01

Labels
0.6.0 Release v0.6.0 help wanted Extra attention is needed improvement Improvements on everything
Projects
None yet
Milestone
No milestone
2 participants
@jerryshao @noidname01