Skip to content

Commit 2d02c17

Browse files
authored
Set options to allow other Doxygen docs to link to AMReX. (AMReX-Codes#2424)
* Set options to allow other Doxygen docs to link to AMReX. * move amrex xml tag file to folder for uploading to webpage.
1 parent f75e129 commit 2d02c17

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
lines changed

Docs/Doxygen/doxygen.conf

+4-4
Original file line numberDiff line numberDiff line change
@@ -44,14 +44,14 @@ PROJECT_NUMBER =
4444
# for a project that appears at the top of each page and should give viewer a
4545
# quick idea about the purpose of the project. Keep the description short.
4646

47-
PROJECT_BRIEF = "Block-Structured AMR Software Framework"
47+
PROJECT_BRIEF = "Block-Structured AMR Software Framework"
4848

4949
# With the PROJECT_LOGO tag one can specify a logo or an icon that is included
5050
# in the documentation. The maximum height of the logo should not exceed 55
5151
# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
5252
# the logo to the output directory.
5353

54-
PROJECT_LOGO = "./resize_AMReX_logo.png"
54+
PROJECT_LOGO = "./resize_AMReX_logo.png"
5555

5656
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
5757
# into which the generated documentation will be written. If a relative path is
@@ -328,7 +328,7 @@ AUTOLINK_SUPPORT = YES
328328
# diagrams that involve STL classes more complete and accurate.
329329
# The default value is: NO.
330330

331-
BUILTIN_STL_SUPPORT = NO
331+
BUILTIN_STL_SUPPORT = YES
332332

333333
# If you use Microsoft's C++/CLI language, you should set this option to YES to
334334
# enable parsing support.
@@ -2099,7 +2099,7 @@ TAGFILES =
20992099
# tag file that is based on the input files it reads. See section "Linking to
21002100
# external documentation" for more information about the usage of tag files.
21012101

2102-
GENERATE_TAGFILE =
2102+
GENERATE_TAGFILE = amrex-doxygen-web.tag.xml
21032103

21042104
# If the ALLEXTERNALS tag is set to YES, all external class will be listed in
21052105
# the class index. If set to NO, only the inherited external classes will be

build_docs.sh

+2
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@ mkdir -p docs_html/doxygen
2525
cp -rp ../Docs/Doxygen/html/* docs_html/doxygen/
2626
mkdir -p docs_xml/doxygen
2727
cp -rp ../Docs/Doxygen/xml/* docs_xml/doxygen/
28+
# add tagfile to allow other docs to interlink with amrex
29+
cp ../Docs/Doxygen/amrex-doxygen-web.tag.xml docs_xml/doxygen/.
2830

2931
# add sphinx
3032
cp -rp ../Docs/sphinx_documentation/build/html/* docs_html/

0 commit comments

Comments
 (0)