Skip to content

[newchem-cpp] Add basic doxygen configuration file#433

Draft
mabruzzo wants to merge 1 commit into
grackle-project:newchem-cppfrom
mabruzzo:ncc/doxygen
Draft

[newchem-cpp] Add basic doxygen configuration file#433
mabruzzo wants to merge 1 commit into
grackle-project:newchem-cppfrom
mabruzzo:ncc/doxygen

Conversation

@mabruzzo

Copy link
Copy Markdown
Collaborator

The basic premise here is that we may use doxygen to render Grackle's internal API on the documentation website (in the section dedicated to development).

There are 2 ways we could ultimately use this documentation:

  • with the Breathe sphinx extension.
  • to render separate webpages that we host on ReadTheDocs and link to (but the theming will look very different)

This PR is just adds a basic configuration file and checks to see if we can run doxygen without any errors.

@mabruzzo mabruzzo added the documentation Documentation related label Sep 30, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Documentation related

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant