[Docs] Refine the API reference generation process for libraries #453
Conversation
Signed-off-by: acezen <qiaozi.zwb@alibaba-inc.com>
|
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? |
acezen
changed the title
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. |
Signed-off-by: acezen <qiaozi.zwb@alibaba-inc.com>
Thanks Sem, added pyspark install in docs generation process, the CI has passed |
.github/workflows/java.yml
Outdated
| run: | | ||
| export JAVA_HOME=${JAVA_HOME_11_X64} | ||
| pushd java | ||
| mvn spotless:check |
There was a problem hiding this comment.
Maybe let's add --no-transfer-progress in java too? Without that option, it will be much harder to read logs in GitHub actions. I would recommend using that option in every place in CI; that option was introduced for CI builds mostly to make logs readable.
|
@lixueclaire @Thespica any comments? I prepare to merge the PR today. |
LGTM~ |
…che#453) --------- Signed-off-by: acezen <qiaozi.zwb@alibaba-inc.com>
Proposed changes
related issue #432
Checklist
Put an
xin 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.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...