Skip to content

Commit b5fb51e

Browse files
committed
some fixes...but not enough
1 parent 224c2ae commit b5fb51e

5 files changed

Lines changed: 43 additions & 29 deletions

File tree

Doxyfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1743,7 +1743,7 @@ FORMULA_MACROFILE =
17431743
# The default value is: NO.
17441744
# This tag requires that the tag GENERATE_HTML is set to YES.
17451745

1746-
USE_MATHJAX = YES
1746+
USE_MATHJAX = NO
17471747

17481748
# With MATHJAX_VERSION it is possible to specify the MathJax version to be used.
17491749
# Note that the different versions of MathJax have different requirements with

include/gl/graph.hpp

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -76,19 +76,17 @@ struct to_impl;
7676
///
7777
/// ### Mathematics
7878
/// Inline math: \f$V = E - F + 2\f$
79-
/// Big-O: \f$\mathcal{O}(\vert V \vert + \vert E \vert)\f$
79+
/// Big-O: \f$\mathcal{O}(|V| + |E|)\f$
8080
///
8181
/// Display math:
82-
///
83-
/// $$
84-
/// \sum_{v \in V} \text{deg}(v) = 2 \vert E \vert
85-
/// $$
82+
/// ```math
83+
/// \sum_{v \in V} \text{deg}(v) = 2 |E|
84+
/// ```
8685
///
8786
/// Complex environment:
88-
///
89-
/// $$
90-
/// A_{i,j} = \begin{cases} 1 & \text{if } (i,j) \in E \\\\ 0 & \text{otherwise} \end{cases}
91-
/// $$
87+
/// ```math
88+
/// A_{i,j} = \begin{cases} 1 & \text{if } (i,j) \in E \\ 0 & \text{otherwise} \end{cases}
89+
/// ```
9290
///
9391
/// ### Code Example
9492
/// ```cpp
@@ -105,9 +103,9 @@ struct to_impl;
105103
/// ```
106104
///
107105
/// ### References
108-
/// For a general overview and integration instructions, see the [Project Overview](README.md#overview)
109-
/// or the [Installation Guide](README.md#installing-the-library).
110-
/// A simple reference [MAIN PAGE](README.md)
106+
/// For a general overview and integration instructions, see the [Project Overview](/#overview)
107+
/// or the [Installation Guide](/#installing-the-library).
108+
/// A simple reference [MAIN PAGE](/)
111109
///
112110
/// > [!WARNING]
113111
/// > This class relies on its internal implementation tag to correctly define its layout. Modifying

mkdocs.yml

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -7,20 +7,18 @@ theme:
77
logo: docs/img/cpp-gl-hex.png
88
favicon: docs/img/cpp-gl-hex.png
99
features:
10-
- navigation.tabs # Top-level navigation tabs
11-
- navigation.sections # Collapsible side-menu sections
10+
- navigation.tabs
11+
- navigation.sections
12+
- navigation.expand
1213
- search.suggest
13-
- search.highlight
14-
- content.code.copy # Copy buttons on code blocks
14+
- content.code.copy
1515
palette:
16-
# Light Mode
1716
- media: "(prefers-color-scheme: light)"
1817
scheme: default
1918
primary: indigo
2019
toggle:
2120
icon: material/brightness-7
2221
name: Switch to dark mode
23-
# Dark Mode
2422
- media: "(prefers-color-scheme: dark)"
2523
scheme: slate
2624
primary: indigo
@@ -31,37 +29,40 @@ theme:
3129
markdown_extensions:
3230
- admonition
3331
- tables
34-
- md_in_html # <-- FIX FOR BADGES
32+
- md_in_html
33+
- attr_list
3534
- pymdownx.details
36-
- pymdownx.superfences
3735
- pymdownx.arithmatex:
3836
generic: true
39-
- pymdownx.snippets: # <-- FIX FOR README DUPLICATION
37+
- pymdownx.superfences:
38+
custom_fences:
39+
- name: math
40+
class: arithmatex
41+
format: !!python/name:pymdownx.arithmatex.fence_mathjax_format
42+
- pymdownx.snippets:
4043
base_path: "."
41-
check_paths: true # Attempts to fix image paths when injecting
44+
check_paths: true
4245

4346
plugins:
4447
- search
48+
- include-markdown
49+
- callouts
4550
- mkdoxy:
4651
projects:
4752
cpp-gl:
48-
src-dirs: include # The directory to scan
53+
src-dirs: include
4954
full-doc: True
5055
doxy-cfg:
51-
# You can override Doxyfile settings here if needed,
52-
# or MkDoxy will just use your existing Doxyfile.
5356
PROJECT_NAME: "CPP-GL"
5457

55-
# Inject MathJax for LaTeX rendering
5658
extra_javascript:
5759
- scripts/mathjax.js
5860
- https://polyfill.io/v3/polyfill.min.js?features=es6
5961
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
6062

6163
nav:
6264
- Home: index.md
63-
- CPP-GL API: # <-- FIXES THE TAB NAME
65+
- CPP-GL API:
6466
- Namespaces: cpp-gl/namespaces.md
6567
- Classes & Structs: cpp-gl/annotated.md
6668
- Files: cpp-gl/files.md
67-
# You can omit macros, modules, etc., if you don't want them cluttering the menu

pyproject.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ readme = "README.md"
66
requires-python = ">=3.14"
77
dependencies = [
88
"mkdocs>=1.6.1",
9+
"mkdocs-callouts>=1.16.0",
910
"mkdocs-material>=9.7.6",
1011
"mkdoxy>=1.2.8",
1112
]

uv.lock

Lines changed: 14 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)