Skip to content

Automatic C++ doc generation#3950

Open
JoffreyDorville wants to merge 14 commits into
openmc-dev:developfrom
JoffreyDorville:automatic_cpp_doc_generation
Open

Automatic C++ doc generation#3950
JoffreyDorville wants to merge 14 commits into
openmc-dev:developfrom
JoffreyDorville:automatic_cpp_doc_generation

Conversation

@JoffreyDorville
Copy link
Copy Markdown
Contributor

@JoffreyDorville JoffreyDorville commented May 29, 2026

Description

This PR adds support for automatic doc generation from C++ sources using doxygen and the python package breathe in addition to our existing sphinx configuration.

This allows to write functions docstrings for the C/C++ API directly in capi.h.
This will also help us write dedicated C++ docs more easily.

I translated a few functions from the docs folder to capi.h just to get a use case example. We can translate everything in a future PR. I imagine this is a perfect task for LLMs.

Checklist

  • I have performed a self-review of my own code
  • I have run clang-format (version 18) on any C++ source files (if applicable)
  • I have followed the style guidelines for Python source files (if applicable)
  • I have made corresponding changes to the documentation (if applicable)
  • I have added tests that prove my fix is effective or that my feature works (if applicable)

@JoffreyDorville
Copy link
Copy Markdown
Contributor Author

I'll just update the developer documentation to add the new doxygen prerequisite.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant