[Docs] Refine the API reference generation process for libraries

apache / incubator-graphar

An open source, standard data file format for graph data storage and retrieval.

https://graphar.apache.org/

Apache License 2.0

195 stars 40 forks source link

[Docs] Refine the API reference generation process for libraries #453

Closed acezen closed 2 months ago

acezen commented 2 months ago

Proposed changes

related issue #432

Add Docs building test to each library CI.
Add API reference docs building to README of library.
Refine the generation process of cpp, pyspark

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.

[ ] I have read the CONTRIBUTING doc
[ ] I have signed the CLA
[ ] Lint and unit tests pass locally with my changes
[ ] I have added tests that prove my fix is effective or that my feature works
[ ] I have added necessary documentation (if appropriate)

Further comments

If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you did and what alternatives you considered, etc...

acezen commented 2 months ago

hi, @SemyonSinchenko. The CI report seems that generate GraphAr PySpark docs need to install pyspark first, I'm not sure pyspark is necessary for docs building or not. Maybe I set something wrong? Can you help me with this?

SemyonSinchenko commented 2 months ago

hi, @SemyonSinchenko. The CI report seems that generate GraphAr PySpark docs need to install pyspark first, I'm not sure pyspark is necessary for docs building or not. Maybe I set something wrong? Can you help me with this?

Yes, it is needed. Under the hood sphinx, actually imports all the Python files to build a tree. On a stage of the importing all the dependencies should be fulfilled.

acezen commented 2 months ago

hi, @SemyonSinchenko. The CI report seems that generate GraphAr PySpark docs need to install pyspark first, I'm not sure pyspark is necessary for docs building or not. Maybe I set something wrong? Can you help me with this?

Yes, it is needed. Under the hood sphinx, actually imports all the Python files to build a tree. On a stage of the importing all the dependencies should be fulfilled.

Thanks Sem, added pyspark install in docs generation process, the CI has passed

acezen commented 2 months ago

@lixueclaire @Thespica any comments? I prepare to merge the PR today.

Thespica commented 2 months ago

@lixueclaire @Thespica any comments? I prepare to merge the PR today.

LGTM~