vesoft-inc / nebula-python

Client API of Nebula Graph in Python
191 stars 75 forks source link

feat: support publish docs to readthedocs #292

Closed liuxiaocs7 closed 10 months ago

liuxiaocs7 commented 11 months ago

What type of PR is this?

What problem(s) does this PR solve?

Issue(s) number:

close: #289

Description:

Hi, @wey-gu, plz help create project plug named nebula-python in readthedocs, and enable this option.

image

I have tested locally:

image

How do you solve it?

Special notes for your reviewer, ex. impact of this fix, design document, etc:

codecov-commenter commented 11 months ago

Codecov Report

All modified lines are covered by tests :white_check_mark:

Comparison is base (cae784f) 77.97% compared to head (0ccb8d7) 77.97%.

:exclamation: Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #292 +/- ## ======================================= Coverage 77.97% 77.97% ======================================= Files 18 18 Lines 2415 2415 ======================================= Hits 1883 1883 Misses 532 532 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

wey-gu commented 11 months ago

Amazing! Was about to be on a long flight, will apply for it ASAP when I am available!

@liuxiaocs7 done with slug nebulagraph-python, I'll PR to adjust that accordingly :)

Nicole00 commented 11 months ago

can we just expose the api in module nebula3.gclient? the thrift api is useless for users.

liuxiaocs7 commented 10 months ago

can we just expose the api in module nebula3.gclient? the thrift api is useless for users.

Exclude some dirs by EXCLUDE_PATTERNs: https://www.sphinx-doc.org/en/master/man/sphinx-apidoc.html