Skip to content

Add comprehensive equations documentation #1136

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sbryngelson merged 7 commits into from
Feb 13, 2026
Merged

Add comprehensive equations documentation #1136

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
1a50fba
Add comprehensive equations documentation
sbryngelson Feb 12, 2026
2845cfc
Integrate equations reference into Doxygen documentation
sbryngelson Feb 12, 2026
5298d5e
Fix Doxygen rendering: use native math syntax and clean up refs
sbryngelson Feb 12, 2026
3a8f9e3
Switch documentation citations to Doxygen BibTeX cite system
sbryngelson Feb 12, 2026
793fa7a
Add author-name citations, CI drift checks, and bib corrections
sbryngelson Feb 12, 2026
04f57ed
Fix low_Mach index swap, int_comp param name, and reviewer feedback
sbryngelson Feb 12, 2026
398f9f3
Merge branch 'master' into equations
sbryngelson Feb 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .typos.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,4 @@ unknwn = "unknwn" # typo for "unknown" - tests unknown param detection
tru = "tru" # typo for "true" in "when_tru" - tests dependency keys

[files]
extend-exclude = ["docs/documentation/references*", "tests/", "toolchain/cce_simulation_workgroup_256.sh", "build-docs/"]
extend-exclude = ["docs/documentation/references*", "docs/references.bib", "tests/", "toolchain/cce_simulation_workgroup_256.sh", "build-docs/"]
4 changes: 4 additions & 0 deletions CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -720,6 +720,7 @@ if (MFC_DOCUMENTATION)
set(DOXYGEN_HTML_OUTPUT "\"${CMAKE_CURRENT_BINARY_DIR}/${target}\"")
set(DOXYGEN_MATHJAX_CODEFILE "\"${CMAKE_CURRENT_SOURCE_DIR}/docs/config.js\"")
set(DOXYGEN_PROJECT_LOGO "\"${CMAKE_CURRENT_SOURCE_DIR}/docs/res/icon.ico\"")
set(DOXYGEN_CITE_BIB_FILES "\"${CMAKE_CURRENT_SOURCE_DIR}/docs/references.bib\"")
set(DOXYGEN_IMAGE_PATH "\"${CMAKE_CURRENT_SOURCE_DIR}/docs/res\"\
\"${CMAKE_CURRENT_SOURCE_DIR}/docs/${target}\"")

Expand Down Expand Up @@ -752,6 +753,8 @@ if (MFC_DOCUMENTATION)
"${opt_parameters_dependency}"
"${${target}_SRCs}" "${${target}_DOCs}"
COMMAND "${DOXYGEN_EXECUTABLE}" "${target}-Doxyfile"
COMMAND "${Python3_EXECUTABLE}" "${CMAKE_CURRENT_SOURCE_DIR}/docs/postprocess_citations.py"
"${CMAKE_CURRENT_BINARY_DIR}/${target}"
WORKING_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}"
COMMENT "${target}: Generating documentation"
)
Expand All @@ -771,6 +774,7 @@ if (MFC_DOCUMENTATION)
add_custom_target(documentation)

find_package(Doxygen REQUIRED dot REQUIRED)
find_package(Python3 REQUIRED COMPONENTS Interpreter)

# > Fetch CSS Theme
ExternalProject_Add(doxygen-awesome-css
Expand Down
2 changes: 1 addition & 1 deletion docs/Doxyfile.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -740,7 +740,7 @@ LAYOUT_FILE =
# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
# search path. See also \cite for info how to create references.

CITE_BIB_FILES =
CITE_BIB_FILES = @DOXYGEN_CITE_BIB_FILES@

#---------------------------------------------------------------------------
# Configuration options related to warning and progress messages
Expand Down
68 changes: 34 additions & 34 deletions docs/documentation/case.md
View file
Open in desktop

Large diffs are not rendered by default.

Loading
Loading