Skip to content

Doxygen for Yucca

Ericka Miller requested to merge doxygen into master

Overarching Goal: Use doxygen to generate documentation for Yucca

Information to be contained in the docs:

  • How to install Yucca
  • Example input files for established QM methods (RHF, RCIS, DFT, ResHF)
  • Development workflows (how to use merge requests, issues, etc)
  • Code-level comment details on Yucca functions and classes
    • Also include these details for qleve?

Target audience:

  • Yucca developers (primarily from Parker Group)
  • NOT external end-users

General structure targets:

  • Doxygen outputs (html) to be hosted as a webpage via GitLab pages
    • Docs to be updated whenever code is pushed to Yucca's master branch
    • Also trigger updates when qleve is updated?
  • README.md page to direct folks who visit the yucca GitLab page to the proper documentation
  • Either integrate the GitLab wiki pages for Yucca into doxygen, or fully port them over to doxygen

Status of development work:

  • Work out how to get doxygen to read in-line comments and produce html docs from them
  • Set-up the integration of doxygen html with GitLab pages
  • Make the doxygen main page and GitLab README.md file "look pretty"
Edited by Ericka Miller

Merge request reports