Skip to content

Commit

Permalink
auto-gen docs of flex (#2851)
Browse files Browse the repository at this point in the history
<!--
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>
  • Loading branch information
ds-ssj committed Jun 9, 2023
1 parent 6851cd9 commit 9bf071c
Show file tree
Hide file tree
Showing 1,438 changed files with 29 additions and 122,442 deletions.
21 changes: 21 additions & 0 deletions docs/Doxyfile-flex
@@ -0,0 +1,21 @@
PROJECT_NAME = "Flex"
PROJECT_NUMBER = "0.17.9"
OUTPUT_DIRECTORY = "_build/latest/html/reference/"
HTML_OUTPUT = "flex"

INPUT = ../flex/storages/rt_mutable_graph \
../flex/engines/graph_db/app \
../flex/engines/graph_db/database \
../flex/utils \

FILE_PATTERNS = *.h *.cc
RECURSIVE = YES
OPTIMIZE_OUTPUT_FOR_C = NO

EXTRACT_ALL = YES
EXTRACT_PRIVATE = YES
EXTRACT_STATIC = YES

TYPED_HIDES_STRUCT = YES
GENERATE_LATEX = NO
GENERATE_HTML = YES
3 changes: 3 additions & 0 deletions docs/Makefile
Expand Up @@ -41,6 +41,9 @@ clean:
cd ${WORKING_DIR}/../analytical_engine/java && \
mvn -P javadoc javadoc:aggregate -Dmaven.antrun.skip=true -DskipTests -Djavadoc.output.directory=${WORKING_DIR}/$(BUILDDIR)/${TAG}/$@/reference -Djavadoc.output.destDir=gae_java --quiet \

@echo "Building Java doc to $(BUILDDIR)/${TAG}/$@/reference/flex"
@doxygen Doxyfile-flex

doxygen:
@mkdir -p _build
@doxygen Doxyfile
2 changes: 1 addition & 1 deletion docs/index.rst
Expand Up @@ -117,6 +117,7 @@ and the vineyard store that offers efficient in-memory data transfers.
reference/python_index
reference/analytical_engine_index
Analytical Engine Java API Reference <reference/gae_java/index>
Flex API Reference <reference/flex/index>

.. toctree::
:maxdepth: 2
Expand All @@ -130,4 +131,3 @@ Indices and tables
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

4 changes: 4 additions & 0 deletions docs/reference/flex/index.rst
@@ -0,0 +1,4 @@
Flex API Reference
========================

Stub page for the Flex API reference docs; actual source is located in the flex/ directory.
136 changes: 0 additions & 136 deletions flex/docs/html/allocators_8h.html

This file was deleted.

21 changes: 0 additions & 21 deletions flex/docs/html/allocators_8h__dep__incl.map

This file was deleted.

1 change: 0 additions & 1 deletion flex/docs/html/allocators_8h__dep__incl.md5

This file was deleted.

Binary file removed flex/docs/html/allocators_8h__dep__incl.png
Binary file not shown.
5 changes: 0 additions & 5 deletions flex/docs/html/allocators_8h__incl.map

This file was deleted.

1 change: 0 additions & 1 deletion flex/docs/html/allocators_8h__incl.md5

This file was deleted.

Binary file removed flex/docs/html/allocators_8h__incl.png
Binary file not shown.

0 comments on commit 9bf071c

Please sign in to comment.