init

SpectraL519 · SpectraL519 · commit 224c2ae87481 · 2026-04-21T23:44:41.000+02:00
diff --git a/.python-version b/.python-version
@@ -0,0 +1 @@
+3.14
diff --git a/Doxyfile b/Doxyfile
@@ -524,19 +524,19 @@ TIMESTAMP              = DATE
 # normally produced when WARNINGS is set to YES.
 # The default value is: NO.
 
-EXTRACT_ALL            = YES
+EXTRACT_ALL            = NO
 
 # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
 # be included in the documentation.
 # The default value is: NO.
 
-EXTRACT_PRIVATE        = YES
+EXTRACT_PRIVATE        = NOE
 
 # If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual
 # methods of a class will be included in the documentation.
 # The default value is: NO.
 
-EXTRACT_PRIV_VIRTUAL   = YES
+EXTRACT_PRIV_VIRTUAL   = NO
 
 # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
 # scope will be included in the documentation.
@@ -1240,7 +1240,7 @@ IGNORE_PREFIX          =
 # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
 # The default value is: YES.
 
-GENERATE_HTML          = YES
+GENERATE_HTML          = NO
 
 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
@@ -1275,7 +1275,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            = docs/style/header.html
+HTML_HEADER            =
 
 # 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
@@ -1315,7 +1315,7 @@ HTML_STYLESHEET        =
 # documentation.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-HTML_EXTRA_STYLESHEET  = docs/style/doxygen-awesome-css/doxygen-awesome.css
+HTML_EXTRA_STYLESHEET  =
 
 # 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
@@ -1325,11 +1325,7 @@ HTML_EXTRA_STYLESHEET  = docs/style/doxygen-awesome-css/doxygen-awesome.css
 # 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 = \
-    docs/style/doxygen-awesome-css/doxygen-awesome-darkmode-toggle.js \
-    docs/style/doxygen-awesome-css/doxygen-awesome-fragment-copy-button.js \
-    docs/style/doxygen-awesome-css/doxygen-awesome-paragraph-link.js \
-    docs/style/doxygen-awesome-css/doxygen-awesome-interactive-toc.js
+HTML_EXTRA_FILES       =
 
 # The HTML_COLORSTYLE tag can be used to specify if the generated HTML output
 # should be rendered with a dark or light theme.
@@ -2191,7 +2187,7 @@ MAN_LINKS              = NO
 # captures the structure of the code including all documentation.
 # The default value is: NO.
 
-GENERATE_XML           = NO
+GENERATE_XML           = YES
 
 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
@@ -2208,7 +2204,7 @@ XML_OUTPUT             = xml
 # The default value is: YES.
 # This tag requires that the tag GENERATE_XML is set to YES.
 
-XML_PROGRAMLISTING     = YES
+XML_PROGRAMLISTING     = NO
 
 # If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include
 # namespace members in file scope as well, matching the HTML output.
diff --git a/Makefile b/Makefile
@@ -1,13 +1,17 @@
-.PHONY: doxy clean-doxy clean
+.PHONY: docs serve-docs clean-docs clean
 
-doxy:
-	@echo "==> Building Doxygen documentation..."
-	doxygen Doxyfile
-	uv run python scripts/postprocess_doxyhtml.py documentation/ --img-rules docs/style/img_style_rules.json
-	@echo "==> Doxygen build complete."
+docs:
+	@echo "==> Building MkDocs documentation..."
+	uv run mkdocs build
+	@echo "==> Documentation build complete. Output is in site/"
 
-clean-doxy:
-	@echo "==> Cleaning Doxygen build directory..."
-	rm -rf documentation/
+serve-docs:
+	@echo "==> Serving MkDocs documentation locally..."
+	uv run mkdocs serve
 
-clean: clean-doxy
+clean-docs:
+	@echo "==> Cleaning documentation build directories..."
+	rm -rf site/
+	rm -rf xml/
+
+clean: clean-docs
diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1 @@
+--8<-- "README.md"
diff --git a/docs/scripts/mathjax.js b/docs/scripts/mathjax.js
@@ -0,0 +1,12 @@
+window.MathJax = {
+  tex: {
+    inlineMath: [["\\(", "\\)"]],
+    displayMath: [["\\[", "\\]"]],
+    processEscapes: true,
+    processEnvironments: true
+  },
+  options: {
+    ignoreHtmlClass: ".*|",
+    processHtmlClass: "arithmatex"
+  }
+};
diff --git a/include/gl/graph.hpp b/include/gl/graph.hpp
@@ -79,11 +79,13 @@ struct to_impl;
 /// Big-O: \f$\mathcal{O}(\vert V \vert + \vert E \vert)\f$
 ///
 /// Display math:
+///
 /// $$
 /// \sum_{v \in V} \text{deg}(v) = 2 \vert E \vert
 /// $$
 ///
 /// Complex environment:
+///
 /// $$
 /// A_{i,j} = \begin{cases} 1 & \text{if } (i,j) \in E \\\\ 0 & \text{otherwise} \end{cases}
 /// $$
diff --git a/main.py b/main.py
@@ -0,0 +1,6 @@
+def main():
+    print("Hello from cpp-gl!")
+
+
+if __name__ == "__main__":
+    main()
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -0,0 +1,67 @@
+site_name: CPP-GL
+site_description: "General-purpose Template Graph and Hypergraph Library for Modern C++"
+repo_url: "https://github.com/SpectraL519/cpp-gl"
+
+theme:
+  name: material
+  logo: docs/img/cpp-gl-hex.png
+  favicon: docs/img/cpp-gl-hex.png
+  features:
+    - navigation.tabs # Top-level navigation tabs
+    - navigation.sections # Collapsible side-menu sections
+    - search.suggest
+    - search.highlight
+    - content.code.copy # Copy buttons on code blocks
+  palette:
+    # Light Mode
+    - media: "(prefers-color-scheme: light)"
+      scheme: default
+      primary: indigo
+      toggle:
+        icon: material/brightness-7
+        name: Switch to dark mode
+    # Dark Mode
+    - media: "(prefers-color-scheme: dark)"
+      scheme: slate
+      primary: indigo
+      toggle:
+        icon: material/brightness-4
+        name: Switch to light mode
+
+markdown_extensions:
+  - admonition
+  - tables
+  - md_in_html          # <-- FIX FOR BADGES
+  - pymdownx.details
+  - pymdownx.superfences
+  - pymdownx.arithmatex:
+      generic: true
+  - pymdownx.snippets:  # <-- FIX FOR README DUPLICATION
+      base_path: "."
+      check_paths: true # Attempts to fix image paths when injecting
+
+plugins:
+  - search
+  - mkdoxy:
+      projects:
+        cpp-gl:
+          src-dirs: include # The directory to scan
+          full-doc: True
+          doxy-cfg:
+            # You can override Doxyfile settings here if needed,
+            # or MkDoxy will just use your existing Doxyfile.
+            PROJECT_NAME: "CPP-GL"
+
+# Inject MathJax for LaTeX rendering
+extra_javascript:
+  - scripts/mathjax.js
+  - https://polyfill.io/v3/polyfill.min.js?features=es6
+  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
+
+nav:
+  - Home: index.md
+  - CPP-GL API: # <-- FIXES THE TAB NAME
+    - Namespaces: cpp-gl/namespaces.md
+    - Classes & Structs: cpp-gl/annotated.md
+    - Files: cpp-gl/files.md
+    # You can omit macros, modules, etc., if you don't want them cluttering the menu
diff --git a/pyproject.toml b/pyproject.toml
@@ -0,0 +1,11 @@
+[project]
+name = "cpp-gl"
+version = "0.1.0"
+description = "Add your description here"
+readme = "README.md"
+requires-python = ">=3.14"
+dependencies = [
+    "mkdocs>=1.6.1",
+    "mkdocs-material>=9.7.6",
+    "mkdoxy>=1.2.8",
+]
diff --git a/uv.lock b/uv.lock
