From b5db7288bbbc4023f6974e83d345057182a0e777 Mon Sep 17 00:00:00 2001 From: Paul Romano Date: Fri, 17 Jul 2026 09:49:55 -0500 Subject: [PATCH] Small fixes; use C domain for capi.h --- docs/doxygen/Doxyfile | 3 +-- docs/source/conf.py | 9 +++++++-- include/openmc/capi.h | 2 +- 3 files changed, 9 insertions(+), 5 deletions(-) diff --git a/docs/doxygen/Doxyfile b/docs/doxygen/Doxyfile index 186fd8a011..75702eff7c 100644 --- a/docs/doxygen/Doxyfile +++ b/docs/doxygen/Doxyfile @@ -7,8 +7,7 @@ PROJECT_NAME = OpenMC QUIET = YES WARN_IF_UNDOCUMENTED = NO -INPUT = ../../include/openmc/ -RECURSIVE = YES +INPUT = ../../include/openmc/capi.h GENERATE_HTML = NO GENERATE_LATEX = NO GENERATE_XML = YES diff --git a/docs/source/conf.py b/docs/source/conf.py index 699b75d340..61740239bf 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -11,7 +11,10 @@ # All configuration values have a default; values that are commented out # serve to show the default. -import sys, os, subprocess +import os +from pathlib import Path +import subprocess +import sys # Determine if we're on Read the Docs server on_rtd = os.environ.get('READTHEDOCS', None) == 'True' @@ -48,7 +51,8 @@ extensions = [ ] if not on_rtd: extensions.append('sphinxcontrib.rsvgconverter') - subprocess.run(['doxygen'], cwd='../doxygen') + doxygen_dir = Path(__file__).parents[1] / 'doxygen' + subprocess.run(['doxygen'], cwd=doxygen_dir, check=True) # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -123,6 +127,7 @@ pygments_style = 'tango' breathe_projects = {"OpenMC": "../doxygen/xml"} breathe_default_project = "OpenMC" +breathe_domain_by_file_pattern = {"*capi.h": "c"} # -- Options for HTML output --------------------------------------------------- diff --git a/include/openmc/capi.h b/include/openmc/capi.h index f8b13ae582..9a7a8480b8 100644 --- a/include/openmc/capi.h +++ b/include/openmc/capi.h @@ -302,7 +302,7 @@ int openmc_zernike_filter_set_params( int openmc_particle_filter_get_bins(int32_t idx, int32_t bins[]); //! Sets the mesh and energy grid for CMFD reweight -//! \param[in] meshtyally_id id of CMFD Mesh Tally +//! \param[in] meshtally_id id of CMFD Mesh Tally //! \param[in] cmfd_indices indices storing spatial and energy dimensions of //! CMFD problem \param[in] norm CMFD normalization factor void openmc_initialize_mesh_egrid(