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

auto-generate docs for Flex #2726

Closed
yecol opened this issue May 23, 2023 · 2 comments
Closed

auto-generate docs for Flex #2726

yecol opened this issue May 23, 2023 · 2 comments
Assignees
Labels
component:doc Improvements or additions to documentation good first issue Good for newcomers

Comments

@yecol
Copy link
Collaborator

yecol commented May 23, 2023

Currently the reference doc files for Flex is pre-built and hosted in the code-repo,
with path: /flex/docs

Please integrate the generate cmd to make docs, following the manner we used for the project:

  • auto-gen the docs;
  • please note that the generated files should be in gh-pages branch, rather than main;
  • maybe output the generated files to a subfolder Flex under section REFERENCES.
@yecol yecol added component:doc Improvements or additions to documentation good first issue Good for newcomers labels May 23, 2023
@ds-ssj ds-ssj self-assigned this Jun 6, 2023
@ds-ssj
Copy link
Collaborator

ds-ssj commented Jun 9, 2023

In this issue, do we need to generate html files directly under REFERENCES (similar to the GAE JAVA API) or do we need to re-describe them in the style of rst files (similar to the GAE API and Python API) and then generate html files? @yecol

@yecol
Copy link
Collaborator Author

yecol commented Jun 9, 2023

The first solution is fine, no need to re-describe them. :)

This was referenced Jun 9, 2023
ds-ssj added a commit that referenced this issue Jun 9, 2023
<!--
Thanks for your contribution! please review
https://github.com/alibaba/GraphScope/blob/main/CONTRIBUTING.md before
opening an issue.
-->

## What do these changes do?

<!-- Please give a short brief about these changes. -->

Auto-gen the docs of `flex` and remove the pre-built html files. Due to
the reduction of dependencies at build time (e.g. using cmake for flex),
a new Doxygen file was created, namely `Doxygen-flex`.

## Related issue number
#2726

Signed-off-by: Sijie Shen <shensijie.ssj@alibaba-inc.com>
@ds-ssj ds-ssj closed this as completed Jun 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:doc Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants