apache / apache/gravitino

[Improvement] Improve Gravitino Python client document

Open
#4,797 3 comments 0 reactions 1 assignee Claimed by @noidname01 View on GitHub
improvement
Dominant language
Java
Stars
3.2k
Forks
935
Avg merge
1d 16h
Merged PRs (30d)
298

Description

### What would you like to be improved?

Currently, the Gravitino Python client uses Pydoc to generate documents. But it displays the compile path in the documents.

![image](https://github.com/user-attachments/assets/aceda686-e4cb-42fd-b4e0-ed28324cdfc6)

We are try to fix this issue in the #4775, but it doesn't solve this problem very well

### How should we improve?

So community suggestion use sphinx to generate python docs.

+ https://www.sphinx-doc.org/en/master/
+ https://github.com/sphinx-doc/sphinx

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.