awesome Doxygen

Author: at0m741

Doxyfile

@@ -949,7 +949,7 @@ WARN_LOGFILE           =
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = includes Plugins
+INPUT                  = includes Plugins docs/BSSN_Grid_Overview.hpp
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -1250,7 +1250,7 @@ GENERATE_HTML          = YES
 # The default directory is: html.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-HTML_OUTPUT            = .
+HTML_OUTPUT            = html
 
 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
 # generated HTML page (for example: .htm, .php, .asp).
@@ -1277,7 +1277,7 @@ HTML_FILE_EXTENSION    = .html
 # of the possible markers and block names see the documentation.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-HTML_HEADER            =
+HTML_HEADER            = docs/doxygen-awesome/header.html
 
 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
 # generated HTML page. If the tag is left blank doxygen will generate a standard
@@ -1317,7 +1317,8 @@ HTML_STYLESHEET        =
 # documentation.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-HTML_EXTRA_STYLESHEET  =
+HTML_EXTRA_STYLESHEET  = docs/doxygen-awesome/doxygen-awesome.css \
+                         docs/custom-physics.css
 
 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
 # other source files which should be copied to the HTML output directory. Note
@@ -1327,7 +1328,8 @@ HTML_EXTRA_STYLESHEET  =
 # files will be copied as-is; there are no commands or markers available.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-HTML_EXTRA_FILES       =
+HTML_EXTRA_FILES       = docs/doxygen-awesome/doxygen-awesome-darkmode-toggle.js \
+                         docs/doxygen-awesome/doxygen-awesome-fragment-copy-button.js
 
 # The HTML_COLORSTYLE tag can be used to specify if the generated HTML output
 # should be rendered with a dark or light theme.
@@ -1340,7 +1342,7 @@ HTML_EXTRA_FILES       =
 # The default value is: AUTO_LIGHT.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-HTML_COLORSTYLE        = AUTO_LIGHT
+HTML_COLORSTYLE        = LIGHT
 
 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
 # will adjust the colors in the style sheet and background images according to
@@ -1680,7 +1682,7 @@ GENERATE_TREEVIEW      = YES
 # The default value is: NO.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-FULL_SIDEBAR           = NO
+FULL_SIDEBAR           = YES
 
 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
 # doxygen will group on one line in the generated HTML documentation.
@@ -1759,7 +1761,7 @@ USE_MATHJAX            = YES
 # The default value is: MathJax_2.
 # This tag requires that the tag USE_MATHJAX is set to YES.
 
-MATHJAX_VERSION        = MathJax_2
+MATHJAX_VERSION        = MathJax_3
 
 # When MathJax is enabled you can set the default output format to be used for
 # the MathJax output. For more details about the output format see MathJax
@@ -2329,7 +2331,7 @@ ENABLE_PREPROCESSING   = YES
 # The default value is: NO.
 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
 
-MACRO_EXPANSION        = NO
+MACRO_EXPANSION        = YES
 
 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
 # the macro expansion is limited to the macros specified with the PREDEFINED and

docs/BSSN_Grid_Overview.hpp

@@ -0,0 +1,39 @@
+/**
+ * @defgroup BSSN_Grid BSSN Grid Module
+ * @brief BSSN-based numerical relativity infrastructure for evolving Einstein's equations.
+ *
+ * @details
+ * This module implements the Baumgarte–Shapiro–Shibata–Nakamura (BSSN) formulation of the
+ * 3+1 Einstein equations:
+ *
+ * \f[
+ * R_{ij} = \tilde{R}_{ij} + R^{\chi}_{ij}
+ * \f]
+ *
+ * with the conformal decomposition:
+ *
+ * \f[
+ * \gamma_{ij} = \chi^{-1} \tilde{\gamma}_{ij}, \quad \det(\tilde{\gamma}) = 1
+ * \f]
+ *
+ * Stored variables:
+ * - Conformal metric \f$ \tilde{\gamma}_{ij} \f$
+ * - Conformal factor \f$ \chi = e^{-4\phi} \f$
+ * - Trace-free curvature \f$ \tilde{A}_{ij} \f$
+ * - Mean curvature \f$ K \f$
+ * - Contracted Christoffels \f$ \tilde{\Gamma}^i \f$
+ * - Gauge: lapse \f$ \alpha \f$, shift \f$ \beta^i \f$
+ *
+ * Architecture:
+ * - Structure-of-Arrays (SoA) grid layout
+ * - Halo / ghost zones for finite differences
+ * - Cached geometric tensors (\tilde{\Gamma}, Ricci, constraints)
+ * - RK4 time integration
+ *
+ * Numerics:
+ * - Centered finite differences
+ * - Kreiss--Oliger dissipation
+ * - Constraint monitoring
+ *
+ * @note This documentation follows the conventions of Alcubierre (2008).
+ */

docs/custom-physics.css

@@ -0,0 +1,9 @@
+body {
+  font-family: "Latin Modern Roman", "Times New Roman", serif;
+}
+.math {
+  font-size: 1.05em;
+}
+div.contents {
+  max-width: 1200px;
+}

docs/doxygen-awesome/header.html

@@ -0,0 +1,2 @@
+<script src="doxygen-awesome-darkmode-toggle.js"></script>
+<script src="doxygen-awesome-fragment-copy-button.js"></script>

docs/html/_allocator_8hpp.html

@@ -0,0 +1,8 @@
+var _allocator_8hpp =
+[
+    [ "AlignedAllocator< T, Alignment >", "struct_aligned_allocator.html", "struct_aligned_allocator" ],
+    [ "AlignedAllocator< T, Alignment >::rebind< U >", "struct_aligned_allocator_1_1rebind.html", "struct_aligned_allocator_1_1rebind" ],
+    [ "aligned_vector", "_allocator_8hpp.html#a6e5808b7535c27dd576a6f559bc9ca83", null ],
+    [ "operator!=", "_allocator_8hpp.html#a5550f3bddd398c5423d432894fa2966d", null ],
+    [ "operator==", "_allocator_8hpp.html#ace395aad5a8656fbf988f8315039c92c", null ]
+];