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.

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

feat: support publish docs to readthedocs #292

Merged
merged 18 commits into from
Oct 17, 2023

Conversation

liuxiaocs7
Copy link
Contributor

@liuxiaocs7 liuxiaocs7 commented Oct 2, 2023

What type of PR is this?

  • bug
  • feature
  • enhancement

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
Copy link

codecov-commenter commented Oct 2, 2023

Codecov Report

All modified lines are covered by tests ✅

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

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

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

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@wey-gu
Copy link
Contributor

wey-gu commented Oct 2, 2023

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

  • work on readthedocs application with community account by @wey-gu

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

@Nicole00
Copy link
Contributor

Nicole00 commented Oct 7, 2023

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

@liuxiaocs7
Copy link
Contributor Author

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

Copy link
Contributor

@Nicole00 Nicole00 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, great job!

@Nicole00 Nicole00 merged commit f3a42e6 into vesoft-inc:master Oct 17, 2023
3 checks passed
wey-gu added a commit that referenced this pull request Oct 17, 2023
Nicole00 pushed a commit that referenced this pull request Oct 23, 2023
* chore: read the doc slug update

ref: #292

* chore: wording of the docs
@wey-gu wey-gu mentioned this pull request Jan 5, 2024
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Publish docs to readthedocs.io
4 participants