[#4829] improvement(client-python): Sphinx Initialization #4830
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@noidname01 can you please fix the conflict? |
|
Let me take a try on this, to how Sphinx goes compared to pydoc. |
jerryshao
reviewed
Sep 4, 2024
| gravitino | ||
|
|
||
|
|
||
|
|
There was a problem hiding this comment.
Can we remove the trailing blank lines, are they nesssary?
There was a problem hiding this comment.
@noidname01 can you please check this comment?
|
Looks like each class will have a Apache License on the doc, maybe sphinx treats the ASF header as a Python doc, is it possible to remove it? 
|
|
@jerryshao Yeah, I plan to do it in next PR originally, as mentioned in #4797, because it will bring a lot of changes. |
|
Oh, I see. Thanks for the explanation. |
noidname01
force-pushed
the
issue-4829
branch
from
6503f10 to
6ef22d1
Compare
jerryshao
approved these changes
Sep 9, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What changes were proposed in this pull request?
docfor Sphinx documents generation and remove old task for docsdocs/build/html, opendocs/build/html/index.htmlto see the home pageCurrent Document Display
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