From 3a96293abd6ad838f800456d8c05722faec77a2b Mon Sep 17 00:00:00 2001 From: Ingmar Schoegl Date: Mon, 17 Jul 2023 09:19:56 -0600 Subject: [PATCH] [docs] Add doxygen treeview --- doc/doxygen/Doxyfile | 8 ++++---- doc/doxygen/mainpage.md | 7 +++++-- doc/sphinx/_static/images/cantera-icon.png | Bin 0 -> 1529 bytes include/cantera/base/ctexceptions.h | 2 +- 4 files changed, 10 insertions(+), 7 deletions(-) create mode 100644 doc/sphinx/_static/images/cantera-icon.png diff --git a/doc/doxygen/Doxyfile b/doc/doxygen/Doxyfile index 269b94c072..e185d9649c 100644 --- a/doc/doxygen/Doxyfile +++ b/doc/doxygen/Doxyfile @@ -51,7 +51,7 @@ PROJECT_BRIEF = # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy # the logo to the output directory. -PROJECT_LOGO = +PROJECT_LOGO = doc/sphinx/_static/images/cantera-icon.png # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path # into which the generated documentation will be written. If a relative path is @@ -866,8 +866,7 @@ INPUT = src/base \ src/transport \ src/zeroD \ include \ - doc/doxygen \ - doc/doxygen/mainpage.md + doc/doxygen # 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 @@ -899,6 +898,7 @@ INPUT_ENCODING = UTF-8 FILE_PATTERNS = *.h \ *.cpp \ *.txt \ + *.md \ *.dox # The RECURSIVE tag can be used to specify whether or not subdirectories should @@ -1511,7 +1511,7 @@ DISABLE_INDEX = NO # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. -GENERATE_TREEVIEW = NO +GENERATE_TREEVIEW = 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. diff --git a/doc/doxygen/mainpage.md b/doc/doxygen/mainpage.md index 511f871ba9..a51cb0ac07 100644 --- a/doc/doxygen/mainpage.md +++ b/doc/doxygen/mainpage.md @@ -1,10 +1,13 @@ # %Cantera C++ Reference +> **Note:** This is the **%Cantera C++ API** documentation; for general +> information on %Cantera, refer to [**Cantera's main website**](https://cantera.org). + Use the menu at the top to view detailed documentation of the code, or use the following shortcuts: -* Overview of [**Cantera Modules**](modules.html) -* Index of [**Cantera Classes**](classes.html) +* Overview of [**Cantera C++ Modules**](modules.html) +* Index of [**Cantera C++ Classes**](classes.html) A topical overview is provided as follows: diff --git a/doc/sphinx/_static/images/cantera-icon.png b/doc/sphinx/_static/images/cantera-icon.png new file mode 100644 index 0000000000000000000000000000000000000000..174d0fe0b94ce102ee3d34dbca9ae62cfbc2247b GIT binary patch literal 1529 zcmVEX>4Tx04R}tkv&MmP!xqvQ?()$1v`j1WT;MdQ4z;lg(6f4wL+^7CNKSiCJjl7 zi=*ILaPVib>fqw6tAnc`2>yV$x;QDiNQw6)g%&Yhc)XAE?m4`7A0RX;OtZS;fTr7K zI++l&xm7XriVy}7Ko7z)vy3@OO2N0j?x~aNF2=L``~IwcHE%H>AQH!!VcNtS#50?= z!FiuJ!b-AAd`>)J(glehxvqHp#<}RSz%wIeCOuCaAr^}rtaLCdnHuplaa7fG$``U8 ztDLtuYn2*n-IKpCoYz;DxlU^oNi1Rs5=1Ddp^OS_#Aw$^v5=KlnXct1va`C500}_lx6vi~*rtpjmgE?_eSad^gZEa<4bO1wgWnpw> zWFU8GbZ8()Nlj2!fese{00YrUL_t(&-tC!9XkA4V$A2^LzK=H7ps{)3Rn)vlQmu`G zE%Lw*6vUM%-MFi`Z0S-2A<82{7mCnTx-1mj=|=1-ZK;b0Nl{S2V(k~zwrOe`lh>p# z&AWHT#hsYEkDK26-sG+B9|kTnXJ-DKGjrygb0I;31PKy!0ue>XFFU({kAM-N0Q3Qm z02w2)3M>N^U=g@(+PA53?{qhb_5nA6Y|Qol6jDAb%d5ImqB4q5YTTO#PPVcBh*oO1 z4UNhevfsD4#~a-y`eU1Wyl8`{6GQegumrd<_ZVLLn7i#f3hW0wUb%xILWowryVvHe2Y8~fqxK*~Qo+(WxcQCV3H&}S<&|qM>Eq}oZAMa9WR3b| zC)bMT%2MP(L*7DVQ=_9msR=+Ag&NW}6c?Gk;Z zv17Fg_kWGPKz1l}=#mwp{%2_cG#PH;R*axXL#`OA(TjF8D)k`nWMlXIrRYSR_aNOL zI{b?*)4$%z?DuA3IN*0T4SmnqBHDC5=Wl4x(arAe4JCSIAn(oEB3f#?rst!ZJ$n!` zh0x(2ti+>!*>QpA>z#bO+upl>Q?sA8LKJwRQ7+DHciw@X(NLlaIAx3Io+h^x!^ykv z3q<%XGXr_=j;#p4j;LP?f{mzH_&~GtwkG?gAU6WJVKJAPr)?%}I0cATf31sKSC72C<(oJk)tK=%Fud0<x32Y+0pbBc`Q1+d-~=rlizcTb2hXlLTLEO6bfnt z)#V$n1y$vXrhNzeHFe~$(oztOPGI|%YcxGJaSC{t4}1XpVUo4W=9d3$ zj>$i!RY52LKAvFpi$mI)Mh&JS5Y3t+uvtx1fmRwcj@Ie1iKDe6hd;4-nI^FVX%v(; z&+-B1(}|QdjcUY