Skip to content

auto-gen docs of flex #2851

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

Merged
merged 1 commit into from
Jun 9, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
21 changes: 21 additions & 0 deletions docs/Doxyfile-flex
Original file line number Diff line number Diff line change
@@ -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
Original file line number Diff line number Diff line change
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
Original file line number Diff line number Diff line change
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
Original file line number Diff line number Diff line change
@@ -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.
Loading