diff options
| author | Glenn Smith <glenn@vector35.com> | 2024-10-30 15:18:07 -0400 |
|---|---|---|
| committer | Glenn Smith <glenn@vector35.com> | 2024-10-30 15:18:07 -0400 |
| commit | 6928112771179025273681227747443208756375 (patch) | |
| tree | 71cb29c8f95669038b8ec3d22a43dc45398acd60 /api-docs | |
| parent | d505d61fa4f709c1a8767baa07c9e5f3277e728a (diff) | |
Update notices for new doxygen version
Diffstat (limited to 'api-docs')
| -rw-r--r-- | api-docs/cppdocs/README.md | 4 | ||||
| -rw-r--r-- | api-docs/cppdocs/build_min_docs.py | 8 |
2 files changed, 6 insertions, 6 deletions
diff --git a/api-docs/cppdocs/README.md b/api-docs/cppdocs/README.md index 615518ee..3c9ed682 100644 --- a/api-docs/cppdocs/README.md +++ b/api-docs/cppdocs/README.md @@ -2,8 +2,6 @@ We currently use `doxygen` for our C++ documentation generation. -> Note: Using anything newer than doxygen 1.9.4 will cause minor issues with the website whenever the selected theme conflicts with the OS/browser light/dark mode selection. - Generating documentation with Doxygen couldn't be simpler. Just install it and run: ``` @@ -14,7 +12,7 @@ From this directory. The output will be stored in `html/` ## Installing doxygen -The theme for our documentation works best with doxygen 1.9.0 - 1.9.4 +The theme for our documentation works best with doxygen 1.12.0 ### macOS (Homebrew) diff --git a/api-docs/cppdocs/build_min_docs.py b/api-docs/cppdocs/build_min_docs.py index 3448d153..90d2aa2b 100644 --- a/api-docs/cppdocs/build_min_docs.py +++ b/api-docs/cppdocs/build_min_docs.py @@ -5,9 +5,11 @@ # This allows shipping a few thousand fewer files in updates including C++ documentation. # # Usage: -# install doxygen 1.9.4 (or this script will not work. running minification on a different version can cause -# real issues.) -# python3 build_min_docs.py +# install doxygen 1.12.0 +# +# make html +# OR +# make docset # =-=-- __DOXYGEN_REQUIRED_VERSION__ = "1.12.0" |