Start using Doxyfile for the docs build

Author: dsuponitskiy-duality

.github/workflows/main.yml

@@ -4,6 +4,7 @@ on:
   push:
     branches:
       - main
+      - 1165-migrate-to-nodejs-24
 
 jobs:
   call_with_gcc:

.gitignore

@@ -20,6 +20,7 @@ test/build
 test/bin
 output.txt
 Doxyfile
+!docs/Doxyfile
 apidoc_warning_logfile.txt
 third-party/distros/gmp-6.1.1
 third-party/distros/gmp-6.1.2

docs/Doxyfile

@@ -0,0 +1,53 @@
+PROJECT_NAME           = "OpenFHE"
+PROJECT_BRIEF          = "OpenFHE Library API"
+OUTPUT_DIRECTORY       = doxyoutput
+CREATE_SUBDIRS         = NO
+ALLOW_UNICODE_NAMES    = NO
+BRIEF_MEMBER_DESC      = YES
+REPEAT_BRIEF           = YES
+ALWAYS_DETAILED_SEC    = NO
+INLINE_INHERITED_MEMB  = NO
+FULL_PATH_NAMES        = YES
+STRIP_FROM_PATH        = ../src
+TAB_SIZE               = 4
+
+INPUT                  = ../src/binfhe/include \
+                         ../src/binfhe/lib \
+                         ../src/core/extras \
+                         ../src/core/include \
+                         ../src/core/lib \
+                         ../src/pke/extras \
+                         ../src/pke/include \
+                         ../src/pke/lib
+FILE_PATTERNS          = *.h \
+                         *.cpp
+RECURSIVE              = YES
+EXCLUDE_PATTERNS       = *.md
+
+GENERATE_HTML          = NO
+GENERATE_LATEX         = NO
+GENERATE_XML           = YES
+XML_OUTPUT             = xml
+XML_PROGRAMLISTING     = NO
+
+QUIET                  = YES
+WARNINGS               = NO
+WARN_IF_UNDOCUMENTED   = NO
+WARN_IF_DOC_ERROR      = NO
+WARN_IF_INCOMPLETE_DOC = NO
+WARN_NO_PARAMDOC       = NO
+
+EXTRACT_ALL            = NO
+EXTRACT_PRIVATE        = NO
+EXTRACT_PRIV_VIRTUAL   = NO
+EXTRACT_STATIC         = YES
+EXTRACT_LOCAL_CLASSES  = YES
+EXTRACT_ANON_NSPACES   = NO
+HIDE_UNDOC_MEMBERS     = NO
+HIDE_UNDOC_CLASSES     = NO
+
+ENABLE_PREPROCESSING   = YES
+MACRO_EXPANSION        = YES
+EXPAND_ONLY_PREDEF     = YES
+PREDEFINED             += NAMESPACE_BEGIN(arbitrary)="namespace arbitrary {"
+PREDEFINED             += NAMESPACE_END(arbitrary)="}"

docs/conf.py

@@ -53,8 +53,6 @@
 breathe_default_project = "OpenFHE"
 
 # Setup the `exhale` extension
-import textwrap
-
 __exhale_base = "../src"
 __exhale_path = {
     # Binfhe
@@ -70,10 +68,6 @@
     f"{__exhale_base}/pke/lib",
 }
 
-container = "INPUT = "
-for path in __exhale_path:
-    container += f"{path} "
-
 
 def specificationsForKind(kind):
     '''
@@ -110,20 +104,7 @@ def specificationsForKind(kind):
     ############################################################################
     "createTreeView":        True,
     "exhaleExecutesDoxygen": True,
-    "exhaleDoxygenStdin": textwrap.dedent(container + '''
-        # For this code-base, the following helps Doxygen get past a macro
-        # that it has trouble with.  It is only meaningful for this code,
-        # not for yours.
-        PREDEFINED += NAMESPACE_BEGIN(arbitrary)="namespace arbitrary {"
-        PREDEFINED += NAMESPACE_END(arbitrary)="}"
-        EXCLUDE_PATTERNS += *.md
-        
-        WARN_IF_UNDOCUMENTED = NO,
-        WARNINGS" = NO,
-        WARN_IF_DOC_ERROR: NO,
-        WARN_IF_INCOMPLETE_DOC: NO,
-        WARN_NO_PARAMDOC: NO
-    '''),
+    "exhaleUseDoxyfile":     True,
     ############################################################################
     # HTML Theme specific configurations.                                      #
     ############################################################################
@@ -510,4 +491,3 @@ def setup(app):
         the_req.write(".. code-block:: nginx\n\n")
         the_req.write(prefix("   ", "".join(l for l in requirements)))
         the_req.write("\n")
-

docs/conf_extensions.rst

@@ -21,8 +21,6 @@
    breathe_default_project = "OpenFHE"
    
    # Setup the `exhale` extension
-   import textwrap
-   
    __exhale_base = "../src"
    __exhale_path = {
        # Binfhe
@@ -38,11 +36,7 @@
        f"{__exhale_base}/pke/lib",
    }
    
-   container = "INPUT = "
-   for path in __exhale_path:
-       container += f"{path} "
-   
-   
+    
    def specificationsForKind(kind):
        '''
        For a given input ``kind``, return the list of reStructuredText specifications
@@ -78,20 +72,7 @@
        ############################################################################
        "createTreeView":        True,
        "exhaleExecutesDoxygen": True,
-       "exhaleDoxygenStdin": textwrap.dedent(container + '''
-           # For this code-base, the following helps Doxygen get past a macro
-           # that it has trouble with.  It is only meaningful for this code,
-           # not for yours.
-           PREDEFINED += NAMESPACE_BEGIN(arbitrary)="namespace arbitrary {"
-           PREDEFINED += NAMESPACE_END(arbitrary)="}"
-           EXCLUDE_PATTERNS += *.md
-           
-           WARN_IF_UNDOCUMENTED = NO,
-           WARNINGS" = NO,
-           WARN_IF_DOC_ERROR: NO,
-           WARN_IF_INCOMPLETE_DOC: NO,
-           WARN_NO_PARAMDOC: NO
-       '''),
+       "exhaleUseDoxyfile":     True,
        ############################################################################
        # HTML Theme specific configurations.                                      #
        ############################################################################
@@ -131,4 +112,3 @@
    
    # Tell sphinx what the pygments highlight language should be.
    highlight_language = 'cpp'
-