Skip to content

Commit

Permalink
Enable breathe.
Browse files Browse the repository at this point in the history
  • Loading branch information
jrood-nrel committed Sep 24, 2024
1 parent 82d357b commit 6e2a90c
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 6 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ jobs:
sudo apt-get update
sudo apt-get install -y --no-install-recommends doxygen graphviz
python3 -m pip install --upgrade pip
pip3 install sphinx sphinx_rtd_theme
pip3 install sphinx sphinx_rtd_theme breathe
- name: Build
# execute from top-level nalu-wind directory
run: |
Expand Down
11 changes: 6 additions & 5 deletions docs/sphinx/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,8 @@
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
# import os
import os
import sys
# sys.path.insert(0, os.path.abspath('.'))
#sys.path.append("../breathe")

# -- General configuration ------------------------------------------------

Expand All @@ -29,15 +27,15 @@
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [ 'sphinx.ext.mathjax']
extensions = [ 'sphinx.ext.mathjax', 'breathe']


# 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_src ='../../src/'
#fortran_ext =[' 'F90']

# The suffix(es) of source filenames.
Expand Down Expand Up @@ -347,6 +345,9 @@
#
# texinfo_no_detailmenu = False

breathe_projects = { 'nalu-wind' : os.path.join(os.getcwd(), 'doxygen', 'xml') }
breathe_default_project = "nalu-wind"

def setup(app):
app.add_object_type("cmakeval", "cmakeval",
objname="CMake configuration value",
Expand Down

0 comments on commit 6e2a90c

Please sign in to comment.