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,52 @@
+PROJECT_NAME           = "OpenFHE"
+PROJECT_BRIEF          = "OpenFHE Library API"
+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

@@ -17,6 +17,7 @@
 import shlex
 import textwrap
 import re
+from pathlib import Path
 from exhale import utils
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
@@ -53,8 +54,6 @@
 breathe_default_project = "OpenFHE"
 
 # Setup the `exhale` extension
-import textwrap
-
 __exhale_base = "../src"
 __exhale_path = {
     # Binfhe
@@ -70,10 +69,32 @@
     f"{__exhale_base}/pke/lib",
 }
 
+_docs_dir = Path(__file__).resolve().parent
+_doxyfile_path = _docs_dir / "Doxyfile"
+
 container = "INPUT = "
 for path in __exhale_path:
     container += f"{path} "
 
+_default_doxygen_config = 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
+''')
+
+_doxygen_config = _default_doxygen_config
+if _doxyfile_path.exists():
+    _doxygen_config = _doxyfile_path.read_text()
+
 
 def specificationsForKind(kind):
     '''
@@ -110,20 +131,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
-    '''),
+    "exhaleDoxygenStdin": _doxygen_config,
     ############################################################################
     # HTML Theme specific configurations.                                      #
     ############################################################################
@@ -510,4 +518,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

@@ -1,5 +1,8 @@
 .. code-block:: py
 
+   from pathlib import Path
+   import textwrap
+
    # Tell Sphinx to use both the `breathe` and `exhale` extensions
    
    extensions = [
@@ -21,8 +24,6 @@
    breathe_default_project = "OpenFHE"
    
    # Setup the `exhale` extension
-   import textwrap
-   
    __exhale_base = "../src"
    __exhale_path = {
        # Binfhe
@@ -38,10 +39,32 @@
        f"{__exhale_base}/pke/lib",
    }
    
+   _docs_dir = Path(__file__).resolve().parent
+   _doxyfile_path = _docs_dir / "Doxyfile"
+   
    container = "INPUT = "
    for path in __exhale_path:
        container += f"{path} "
    
+   _default_doxygen_config = 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
+   ''')
+   
+   _doxygen_config = _default_doxygen_config
+   if _doxyfile_path.exists():
+       _doxygen_config = _doxyfile_path.read_text()
+   
    
    def specificationsForKind(kind):
        '''
@@ -78,20 +101,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
-       '''),
+       "exhaleDoxygenStdin": _doxygen_config,
        ############################################################################
        # HTML Theme specific configurations.                                      #
        ############################################################################
@@ -131,4 +141,3 @@
    
    # Tell sphinx what the pygments highlight language should be.
    highlight_language = 'cpp'
-