Skip to content

Commit 791ee26

Browse files
committedMar 25, 2025·
Updated look and feel for Doxygen-generated documentation.
1 parent b989260 commit 791ee26

39 files changed

+7591
-21
lines changed
 

‎CMakeLists.txt

+2
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,8 @@ ENDIF()
6565
# End BUILDNAME customization.
6666
###
6767

68+
set(abs_top_builddir "${CMAKE_CURRENT_BINARY_DIR}")
69+
set(abs_top_srcdir "${CMAKE_CURRENT_SOURCE_DIR}")
6870

6971
# Determine if DOXYGEN and DOT are available. These will be used
7072
# when building the documentation.

‎RELEASE_NOTES.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Release Notes {#nf_release_notes}
66
This file contains a high-level description of this package's evolution.
77
Entries are in reverse chronological order (most recent first).
88

9-
## 4.6.2 - March 25, 2025
9+
## 4.6.2 - March 26, 2025
1010

1111
### Requirements
1212

‎docs/Doxyfile.developer

+3-2
Original file line numberDiff line numberDiff line change
@@ -1122,7 +1122,8 @@ HTML_STYLESHEET =
11221122
# list). For an example see the documentation.
11231123
# This tag requires that the tag GENERATE_HTML is set to YES.
11241124

1125-
HTML_EXTRA_STYLESHEET =
1125+
HTML_EXTRA_STYLESHEET = ./docs/doxygen-awesome-css/doxygen-awesome.css
1126+
HTML_COLORSTYLE = LIGHT
11261127

11271128
# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
11281129
# other source files which should be copied to the HTML output directory. Note
@@ -1132,7 +1133,7 @@ HTML_EXTRA_STYLESHEET =
11321133
# files will be copied as-is; there are no commands or markers available.
11331134
# This tag requires that the tag GENERATE_HTML is set to YES.
11341135

1135-
HTML_EXTRA_FILES =
1136+
HTML_EXTRA_FILES = ./docs/doxygen-awesome-css/doxygen-awesome-darkmode-toggle.js
11361137

11371138
# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
11381139
# will adjust the colors in the style sheet and background images according to

‎docs/Doxyfile.in

+5-4
Original file line numberDiff line numberDiff line change
@@ -1057,7 +1057,7 @@ HTML_FILE_EXTENSION = .html
10571057
# of the possible markers and block names see the documentation.
10581058
# This tag requires that the tag GENERATE_HTML is set to YES.
10591059

1060-
HTML_HEADER =
1060+
HTML_HEADER = @abs_top_builddir@/docs/header.html
10611061

10621062
# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
10631063
# generated HTML page. If the tag is left blank doxygen will generate a standard
@@ -1090,7 +1090,8 @@ HTML_STYLESHEET =
10901090
# see the documentation.
10911091
# This tag requires that the tag GENERATE_HTML is set to YES.
10921092

1093-
HTML_EXTRA_STYLESHEET =
1093+
HTML_EXTRA_STYLESHEET = @abs_top_srcdir@/docs/doxygen-awesome-css/doxygen-awesome.css
1094+
HTML_COLORSTYLE = LIGHT
10941095

10951096
# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
10961097
# other source files which should be copied to the HTML output directory. Note
@@ -1993,13 +1994,13 @@ SKIP_FUNCTION_MACROS = YES
19931994
# the path). If a tag file is not located in the directory in which doxygen is
19941995
# run, you must also specify the path to the tagfile here.
19951996

1996-
TAGFILES =
1997+
TAGFILES = https://docs.unidata.ucar.edu/netcdf-c/current/netcdf-c.tag
19971998

19981999
# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
19992000
# tag file that is based on the input files it reads. See section "Linking to
20002001
# external documentation" for more information about the usage of tag files.
20012002

2002-
GENERATE_TAGFILE =
2003+
GENERATE_TAGFILE = html/netcdf-fortran.tag
20032004

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

‎docs/Makefile.am

+1-1
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ Doxyfile.in netcdf-f77.md netcdf-f90-sec1-usage.md \
5353
netcdf-f90-sec3-groups.md netcdf-f90-sec5-user_defined_types.md \
5454
netcdf-f90-sec7-attributes.md netcdf-f90.md \
5555
netcdf-f90-sec2-datasets.md netcdf-f90-sec4-dimensions.md \
56-
netcdf-f90-sec6-variables.md
56+
netcdf-f90-sec6-variables.md doxygen-awesome-css header.html
5757

5858
CLEANFILES = doxyfile.stamp
5959

0 commit comments

Comments
 (0)
Please sign in to comment.