Skip to content

Commit 9bf071c

Browse files
authored
auto-gen docs of flex (#2851)
<!-- 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 <[email protected]>
1 parent 6851cd9 commit 9bf071c

File tree

1,438 files changed

+29
-122442
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,438 files changed

+29
-122442
lines changed

docs/Doxyfile-flex

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
PROJECT_NAME = "Flex"
2+
PROJECT_NUMBER = "0.17.9"
3+
OUTPUT_DIRECTORY = "_build/latest/html/reference/"
4+
HTML_OUTPUT = "flex"
5+
6+
INPUT = ../flex/storages/rt_mutable_graph \
7+
../flex/engines/graph_db/app \
8+
../flex/engines/graph_db/database \
9+
../flex/utils \
10+
11+
FILE_PATTERNS = *.h *.cc
12+
RECURSIVE = YES
13+
OPTIMIZE_OUTPUT_FOR_C = NO
14+
15+
EXTRACT_ALL = YES
16+
EXTRACT_PRIVATE = YES
17+
EXTRACT_STATIC = YES
18+
19+
TYPED_HIDES_STRUCT = YES
20+
GENERATE_LATEX = NO
21+
GENERATE_HTML = YES

docs/Makefile

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,9 @@ clean:
4141
cd ${WORKING_DIR}/../analytical_engine/java && \
4242
mvn -P javadoc javadoc:aggregate -Dmaven.antrun.skip=true -DskipTests -Djavadoc.output.directory=${WORKING_DIR}/$(BUILDDIR)/${TAG}/$@/reference -Djavadoc.output.destDir=gae_java --quiet \
4343

44+
@echo "Building Java doc to $(BUILDDIR)/${TAG}/$@/reference/flex"
45+
@doxygen Doxyfile-flex
46+
4447
doxygen:
4548
@mkdir -p _build
4649
@doxygen Doxyfile

docs/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,7 @@ and the vineyard store that offers efficient in-memory data transfers.
117117
reference/python_index
118118
reference/analytical_engine_index
119119
Analytical Engine Java API Reference <reference/gae_java/index>
120+
Flex API Reference <reference/flex/index>
120121

121122
.. toctree::
122123
:maxdepth: 2
@@ -130,4 +131,3 @@ Indices and tables
130131
* :ref:`genindex`
131132
* :ref:`modindex`
132133
* :ref:`search`
133-

docs/reference/flex/index.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Flex API Reference
2+
========================
3+
4+
Stub page for the Flex API reference docs; actual source is located in the flex/ directory.

flex/docs/html/allocators_8h.html

Lines changed: 0 additions & 136 deletions
This file was deleted.

flex/docs/html/allocators_8h__dep__incl.map

Lines changed: 0 additions & 21 deletions
This file was deleted.

flex/docs/html/allocators_8h__dep__incl.md5

Lines changed: 0 additions & 1 deletion
This file was deleted.
-115 KB
Binary file not shown.

flex/docs/html/allocators_8h__incl.map

Lines changed: 0 additions & 5 deletions
This file was deleted.

flex/docs/html/allocators_8h__incl.md5

Lines changed: 0 additions & 1 deletion
This file was deleted.
-4.59 KB
Binary file not shown.

0 commit comments

Comments
 (0)