From 5e50301e0ad0f1ecb1a145e948a36e2aedb7ed0d Mon Sep 17 00:00:00 2001 From: Joffrey Dorville Date: Mon, 1 Jun 2026 17:36:03 -0500 Subject: [PATCH] Doxygen prerequisite in dev guide --- docs/source/devguide/docbuild.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/source/devguide/docbuild.rst b/docs/source/devguide/docbuild.rst index f723db06ea..cda0307cae 100644 --- a/docs/source/devguide/docbuild.rst +++ b/docs/source/devguide/docbuild.rst @@ -14,6 +14,11 @@ Python API. That is, from the root directory of the OpenMC repository: python -m pip install ".[docs]" +The OpenMC documentation also uses Doxygen to automatically generate its +C/C++ API documentation directly from the docstrings available in the source +code. You will need to have a working installation of Doxygen to generate the +documentation locally. + ----------------------------------- Building Documentation as a Webpage -----------------------------------