noidname01 opened a new pull request, #4830:
URL: https://github.com/apache/gravitino/pull/4830
<!--
1. Title: [#<issue>] <type>(<scope>): <subject>
Examples:
- "[#123] feat(operator): support xxx"
- "[#233] fix: check null before access result in xxx"
- "[MINOR] refactor: fix typo in variable name"
- "[MINOR] docs: fix typo in README"
- "[#255] test: fix flaky test NameOfTheTest"
Reference: https://www.conventionalcommits.org/en/v1.0.0/
2. If the PR is unfinished, please mark this PR as draft.
-->
### What changes were proposed in this pull request?
* Add Sphinx configuration files and templates for generating documents
automatically
* Add new task `doc` for Sphinx documents generation and remove old task for
docs
* Generated website files will be in `docs/build/html`, open
`docs/build/html/index.html` to see the home page
* Feel free to improve this document configuration (what contents should be
included, add project logos in documents, etc.)
#### Current Document Display
<img width="1470" alt="image"
src="https://github.com/user-attachments/assets/e98b0233-b9e6-4c68-91a1-487b6ead1c07";>
> NOTES:
> * The current theme is [Furo](https://pradyunsg.me/furo/), feel free to
change if other theme is better
> * It still needs a lot of revision, like mentioned in
https://github.com/apache/gravitino/issues/4797#issuecomment-2323197095
### Why are the changes needed?
Fix: #4829
### Does this PR introduce _any_ user-facing change?
No
### How was this patch tested?
./gradlew client:client-python:doc
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
