Avoid breathe.

Exawind · Sep 25, 2024 · 28ef596 · 28ef596
1 parent 31ee23e
commit 28ef596
Show file tree

Hide file tree

Showing 12 changed files with 6 additions and 339 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -24,9 +24,9 @@ jobs:
         run: |
           export DEBIAN_FRONTEND=noninteractive
           sudo apt-get update
-          sudo apt-get install -y --no-install-recommends doxygen
+          sudo apt-get install -y --no-install-recommends doxygen graphviz
           python3 -m pip install --upgrade pip
-          pip3 install sphinx sphinx_rtd_theme breathe sphinxcontrib-bibtex sphinxcontrib-doxylink
+          pip3 install sphinx sphinx_rtd_theme sphinxcontrib-bibtex
       - name: Build
         # execute from top-level nalu-wind directory
         run: |
@@ -35,6 +35,7 @@ jobs:
           echo "::add-matcher::.github/problem-matchers/sphinx.json"
           sphinx-build -M html ./docs/sphinx ./build_docs/manual -W --keep-going -n 2>&1 | tee -a build-output.txt
           mv ./build_docs/manual/html ./documentation
+          mv ./build_docs/doxygen/html ./documentation/api_docs
           touch ./documentation/.nojekyll
       - name: Report
         run: |

diff --git a/docs/doxygen/Doxyfile b/docs/doxygen/Doxyfile
@@ -11,11 +11,11 @@ EXTRACT_PACKAGE        = YES
 EXTRACT_STATIC         = YES
 EXTRACT_LOCAL_CLASSES  = YES
 EXTRACT_ANON_NSPACES   = NO
-HAVE_DOT               = NO
+HAVE_DOT               = YES
 GENERATE_TODOLIST      = NO
 GENERATE_TESTLIST      = NO
 GENERATE_BUGLIST       = NO
-GENERATE_HTML          = NO
+GENERATE_HTML          = YES
 GENERATE_DOCSET        = NO
 GENERATE_HTMLHELP      = NO
 GENERATE_CHI           = NO
@@ -30,7 +30,7 @@ GENERATE_AUTOGEN_DEF   = NO
 GENERATE_PERLMOD       = NO
 QUIET                  = YES
 WARNINGS               = NO
-GENERATE_XML           = YES
+GENERATE_XML           = NO
 
 FILE_PATTERNS = *.h *.hpp *.H
 RECURSIVE = YES

diff --git a/docs/sphinx/conf.py b/docs/sphinx/conf.py
@@ -33,8 +33,6 @@
               'sphinx.ext.mathjax',
               'sphinx.ext.intersphinx',
               'sphinxcontrib.bibtex',
-              'sphinxcontrib.doxylink',
-              'breathe',
              ]
 bibtex_bibfiles = ['references/references.bib']
 autodoc_default_flags = ['members','show-inheritance','undoc-members']
@@ -43,8 +41,6 @@
 numfig = True
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
-#breathe_projects = {"Nalu-Wind": "../doxygen_output/xml/"}
-#breathe_default_project = "Nalu-Wind"
 
 #fortran_src ='../../src/'
 #fortran_ext =[' 'F90']
@@ -356,9 +352,6 @@
 #
 # texinfo_no_detailmenu = False
 
-breathe_projects = { 'nalu-wind' : os.path.join(os.getcwd(), '..', '..', 'build_docs', 'doxygen', 'xml') }
-breathe_default_project = "nalu-wind"
-
 primary_domain = "cpp"
 
 def setup(app):

diff --git a/docs/sphinx/source/developer/apidocs/actuatorsources.rst b/docs/sphinx/source/developer/apidocs/actuatorsources.rst
diff --git a/docs/sphinx/source/developer/apidocs/eqsystems.rst b/docs/sphinx/source/developer/apidocs/eqsystems.rst
diff --git a/docs/sphinx/source/developer/apidocs/linsys.rst b/docs/sphinx/source/developer/apidocs/linsys.rst
diff --git a/docs/sphinx/source/developer/apidocs/masterelem.rst b/docs/sphinx/source/developer/apidocs/masterelem.rst
diff --git a/docs/sphinx/source/developer/apidocs/postprocess.rst b/docs/sphinx/source/developer/apidocs/postprocess.rst
diff --git a/docs/sphinx/source/developer/apidocs/realms.rst b/docs/sphinx/source/developer/apidocs/realms.rst
diff --git a/docs/sphinx/source/developer/apidocs/userfunc.rst b/docs/sphinx/source/developer/apidocs/userfunc.rst