From 5840dbe60c61f4fc67fe78c017e1c7464c1e5e41 Mon Sep 17 00:00:00 2001 From: Dmitri Smirnov Date: Tue, 14 Apr 2026 15:32:47 -0400 Subject: [PATCH] ci(doxygen): add workflow --- .github/workflows/doxygen-pages.yaml | 91 +++++++++++++ Doxyfile | 194 +++++++++++++++++++++++++++ 2 files changed, 285 insertions(+) create mode 100644 .github/workflows/doxygen-pages.yaml create mode 100644 Doxyfile diff --git a/.github/workflows/doxygen-pages.yaml b/.github/workflows/doxygen-pages.yaml new file mode 100644 index 000000000..a35fe30e9 --- /dev/null +++ b/.github/workflows/doxygen-pages.yaml @@ -0,0 +1,91 @@ +name: Doxygen Docs + +on: + push: + branches: + - main + paths: + - '**/*.h' + - '**/*.hh' + - '**/*.hpp' + - '**/*.hxx' + - '**/*.c' + - '**/*.cc' + - '**/*.cpp' + - '**/*.cxx' + - '**/*.cu' + - '**/*.cuh' + - '**/*.inc' + - README.md + - Doxyfile + - .github/workflows/doxygen-pages.yaml + pull_request: + paths: + - '**/*.h' + - '**/*.hh' + - '**/*.hpp' + - '**/*.hxx' + - '**/*.c' + - '**/*.cc' + - '**/*.cpp' + - '**/*.cxx' + - '**/*.cu' + - '**/*.cuh' + - '**/*.inc' + - README.md + - Doxyfile + - .github/workflows/doxygen-pages.yaml + workflow_dispatch: + +concurrency: + group: github-pages + cancel-in-progress: true + +permissions: + contents: read + +jobs: + build-docs: + name: Build Doxygen + runs-on: ubuntu-latest + steps: + - name: Checkout repository + uses: actions/checkout@v4 + + - name: Install Doxygen and Graphviz + run: | + sudo apt-get update + sudo apt-get install -y doxygen graphviz + + - name: Build documentation + run: doxygen Doxyfile + + - name: Setup Pages + if: github.event_name != 'pull_request' && github.ref == 'refs/heads/main' + uses: actions/configure-pages@v5 + + - name: Add Pages landing file + if: github.event_name != 'pull_request' && github.ref == 'refs/heads/main' + run: touch _build/doxygen/html/.nojekyll + + - name: Upload Pages artifact + if: github.event_name != 'pull_request' && github.ref == 'refs/heads/main' + uses: actions/upload-pages-artifact@v3 + with: + path: _build/doxygen/html + + deploy-pages: + name: Deploy to GitHub Pages + if: github.event_name != 'pull_request' && github.ref == 'refs/heads/main' + needs: build-docs + runs-on: ubuntu-latest + permissions: + pages: write + id-token: write + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + steps: + - name: Deploy docs + id: deployment + uses: actions/deploy-pages@v4 diff --git a/Doxyfile b/Doxyfile new file mode 100644 index 000000000..f1c2c39db --- /dev/null +++ b/Doxyfile @@ -0,0 +1,194 @@ +PROJECT_NAME = "eic-opticks" +PROJECT_NUMBER = "0.3.0" +PROJECT_BRIEF = "GPU-accelerated optical photon transport for Geant4" +OUTPUT_DIRECTORY = _build/doxygen +CREATE_SUBDIRS = NO +ALLOW_UNICODE_NAMES = NO +OUTPUT_LANGUAGE = English + +BRIEF_MEMBER_DESC = YES +REPEAT_BRIEF = YES +ALWAYS_DETAILED_SEC = NO +INLINE_INHERITED_MEMB = NO +FULL_PATH_NAMES = NO +STRIP_FROM_PATH = . +JAVADOC_AUTOBRIEF = YES +MULTILINE_CPP_IS_BRIEF = NO +INHERIT_DOCS = YES +SEPARATE_MEMBER_PAGES = NO + +TAB_SIZE = 4 +OPTIMIZE_OUTPUT_FOR_C = NO +OPTIMIZE_OUTPUT_JAVA = NO +OPTIMIZE_FOR_FORTRAN = NO +OPTIMIZE_OUTPUT_VHDL = NO +MARKDOWN_SUPPORT = YES +AUTOLINK_SUPPORT = YES + +EXTRACT_ALL = YES +EXTRACT_PRIVATE = NO +EXTRACT_PACKAGE = NO +EXTRACT_STATIC = YES +EXTRACT_LOCAL_CLASSES = YES +EXTRACT_LOCAL_METHODS = NO +EXTRACT_ANON_NSPACES = YES + +HIDE_UNDOC_MEMBERS = NO +HIDE_UNDOC_CLASSES = NO +HIDE_FRIEND_COMPOUNDS = NO +HIDE_IN_BODY_DOCS = NO + +INTERNAL_DOCS = NO +CASE_SENSE_NAMES = YES +HIDE_SCOPE_NAMES = NO +HIDE_COMPOUND_REFERENCE= NO +SHOW_INCLUDE_FILES = YES +SHOW_GROUPED_MEMB_INC = NO +FORCE_LOCAL_INCLUDES = NO +INLINE_INFO = YES +SORT_MEMBER_DOCS = YES +SORT_BRIEF_DOCS = NO +SORT_BY_SCOPE_NAME = NO +SORT_MEMBERS_CTORS_1ST = NO +SORT_GROUP_NAMES = NO + +GENERATE_TODOLIST = NO +GENERATE_TESTLIST = NO +GENERATE_BUGLIST = NO +GENERATE_DEPRECATEDLIST= YES + +ENABLED_SECTIONS = +MAX_INITIALIZER_LINES = 30 +SHOW_USED_FILES = YES +SHOW_FILES = YES +SHOW_NAMESPACES = YES +FILE_VERSION_FILTER = + +QUIET = YES +WARNINGS = YES +WARN_IF_UNDOCUMENTED = NO +WARN_IF_DOC_ERROR = YES +WARN_NO_PARAMDOC = NO +WARN_AS_ERROR = NO + +INPUT = README.md \ + include \ + src \ + sysrap \ + CSG \ + CSGOptiX \ + qudarap \ + g4cx \ + u4 \ + dd4hepplugins +INPUT_ENCODING = UTF-8 +FILE_PATTERNS = *.h \ + *.hh \ + *.hpp \ + *.hxx \ + *.c \ + *.cc \ + *.cpp \ + *.cxx \ + *.cu \ + *.cuh \ + *.inc \ + *.md +RECURSIVE = YES +EXCLUDE = build \ + .git \ + .venv \ + optiphy.egg-info +EXCLUDE_PATTERNS = */tests/* \ + */test/* \ + */_build/* +EXCLUDE_SYMLINKS = NO +EXAMPLE_PATH = +EXAMPLE_PATTERNS = * +EXAMPLE_RECURSIVE = NO +IMAGE_PATH = +INPUT_FILTER = +FILTER_PATTERNS = +FILTER_SOURCE_FILES = NO + +SOURCE_BROWSER = YES +INLINE_SOURCES = NO +STRIP_CODE_COMMENTS = YES +REFERENCED_BY_RELATION = YES +REFERENCES_RELATION = YES +REFERENCES_LINK_SOURCE = YES + +USE_HTAGS = NO +VERBATIM_HEADERS = YES +ALPHABETICAL_INDEX = YES +COLS_IN_ALPHA_INDEX = 5 +IGNORE_PREFIX = + +GENERATE_HTML = YES +HTML_OUTPUT = html +HTML_FILE_EXTENSION = .html +HTML_HEADER = +HTML_FOOTER = +HTML_STYLESHEET = +HTML_EXTRA_STYLESHEET = +HTML_EXTRA_FILES = +HTML_COLORSTYLE = AUTO_LIGHT +HTML_COLORSTYLE_HUE = 220 +HTML_COLORSTYLE_SAT = 100 +HTML_COLORSTYLE_GAMMA = 80 +HTML_TIMESTAMP = NO +HTML_DYNAMIC_MENUS = YES +HTML_DYNAMIC_SECTIONS = NO +GENERATE_DOCSET = NO +GENERATE_HTMLHELP = NO +GENERATE_CHI = NO +GENERATE_QHP = NO +GENERATE_ECLIPSEHELP = NO +DISABLE_INDEX = NO +GENERATE_TREEVIEW = YES +FULL_SIDEBAR = NO +ENUM_VALUES_PER_LINE = 1 +TREEVIEW_WIDTH = 250 + +GENERATE_LATEX = NO +GENERATE_RTF = NO +GENERATE_MAN = NO +GENERATE_XML = NO +GENERATE_DOCBOOK = NO +GENERATE_AUTOGEN_DEF = NO +GENERATE_PERLMOD = NO + +CLASS_DIAGRAMS = YES +HAVE_DOT = YES +DOT_NUM_THREADS = 0 +DOT_FONTNAME = Helvetica +DOT_FONTSIZE = 10 +CLASS_GRAPH = YES +COLLABORATION_GRAPH = YES +GROUP_GRAPHS = YES +UML_LOOK = NO +UML_LIMIT_NUM_FIELDS = 10 +DOT_UML_DETAILS = NO +DOT_WRAP_THRESHOLD = 17 +TEMPLATE_RELATIONS = YES +INCLUDE_GRAPH = YES +INCLUDED_BY_GRAPH = YES +CALL_GRAPH = NO +CALLER_GRAPH = NO +GRAPHICAL_HIERARCHY = YES +DIRECTORY_GRAPH = YES +DOT_IMAGE_FORMAT = svg +INTERACTIVE_SVG = YES +DOT_PATH = +DOTFILE_DIRS = +MSCFILE_DIRS = +DOT_GRAPH_MAX_NODES = 70 +MAX_DOT_GRAPH_DEPTH = 0 +DOT_TRANSPARENT = NO +DOT_MULTI_TARGETS = NO +GENERATE_LEGEND = YES +DOT_CLEANUP = YES + +EXTENSION_MAPPING = cu=C++ cuh=C++ + +USE_MDFILE_AS_MAINPAGE = README.md