Skip to content

Commit

Permalink
Doc: renamed Doxygen_Templates/ to style_template/
Browse files Browse the repository at this point in the history
  • Loading branch information
vovamarch committed Nov 6, 2023
1 parent 0cde134 commit 76fd796
Show file tree
Hide file tree
Showing 22 changed files with 33 additions and 18 deletions.
28 changes: 14 additions & 14 deletions Documentation/Doxygen/dap.dxy.in
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ PROJECT_BRIEF = "Interface Firmware for CoreSight Debug Access Port"
# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
# the logo to the output directory.

PROJECT_LOGO = Doxygen_Templates/cmsis_logo_white_small.png
PROJECT_LOGO = style_template/cmsis_logo_white_small.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
Expand Down Expand Up @@ -795,7 +795,7 @@ FILE_VERSION_FILTER =
# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
# tag is left empty.

LAYOUT_FILE = Doxygen_Templates/Layout_forUser.xml
LAYOUT_FILE = style_template/Layout_forUser.xml

# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
# the reference definitions. This must be a list of .bib files. The .bib
Expand Down Expand Up @@ -1338,7 +1338,7 @@ HTML_FILE_EXTENSION = .html
# of the possible markers and block names see the documentation.
# This tag requires that the tag GENERATE_HTML is set to YES.

HTML_HEADER = Doxygen_Templates/header.html
HTML_HEADER = style_template/header.html

# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
# generated HTML page. If the tag is left blank doxygen will generate a standard
Expand All @@ -1348,7 +1348,7 @@ HTML_HEADER = Doxygen_Templates/header.html
# that doxygen normally uses.
# This tag requires that the tag GENERATE_HTML is set to YES.

HTML_FOOTER = Doxygen_Templates/footer.html
HTML_FOOTER = style_template/footer.html

# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
# sheet that is used by each HTML page. It can be used to fine-tune the look of
Expand Down Expand Up @@ -1378,9 +1378,9 @@ HTML_STYLESHEET =
# documentation.
# This tag requires that the tag GENERATE_HTML is set to YES.

HTML_EXTRA_STYLESHEET = Doxygen_Templates/extra_stylesheet.css \
Doxygen_Templates/extra_navtree.css \
Doxygen_Templates/extra_search.css \
HTML_EXTRA_STYLESHEET = style_template/extra_stylesheet.css \
style_template/extra_navtree.css \
style_template/extra_search.css \

# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
# other source files which should be copied to the HTML output directory. Note
Expand All @@ -1390,13 +1390,13 @@ HTML_EXTRA_STYLESHEET = Doxygen_Templates/extra_stylesheet.css \
# files will be copied as-is; there are no commands or markers available.
# This tag requires that the tag GENERATE_HTML is set to YES.

HTML_EXTRA_FILES = Doxygen_Templates/tabs.css \
Doxygen_Templates/version.css \
Doxygen_Templates/tab_b.png \
Doxygen_Templates/printComponentTabs.js \
Doxygen_Templates/darkmode_toggle.js \
Doxygen_Templates/navtree.js \
Doxygen_Templates/dropdown.png
HTML_EXTRA_FILES = style_template/tabs.css \
style_template/version.css \
style_template/tab_b.png \
style_template/printComponentTabs.js \
style_template/darkmode_toggle.js \
style_template/navtree.js \
style_template/dropdown.png

# The HTML_COLORSTYLE tag can be used to specify if the generated HTML output
# should be rendered with a dark or light theme.
Expand Down
8 changes: 4 additions & 4 deletions Documentation/Doxygen/gen_doc.sh
Original file line number Diff line number Diff line change
Expand Up @@ -84,11 +84,11 @@ echo "\"${UTILITY_DOXYGEN}\" dap.dxy"
"${UTILITY_DOXYGEN}" dap.dxy

mkdir -p "${DIRNAME}/../html/search/"
cp -f "${DIRNAME}/Doxygen_Templates/search.css" "${DIRNAME}/../html/search/"
cp -f "${DIRNAME}/Doxygen_Templates/navtree.js" "${DIRNAME}/../html/"
cp -f "${DIRNAME}/Doxygen_Templates/resize.js" "${DIRNAME}/../html/"
cp -f "${DIRNAME}/style_template/search.css" "${DIRNAME}/../html/search/"
cp -f "${DIRNAME}/style_template/navtree.js" "${DIRNAME}/../html/"
cp -f "${DIRNAME}/style_template/resize.js" "${DIRNAME}/../html/"

sed -e "s/{datetime}/${datetime}/" "${DIRNAME}/Doxygen_Templates/footer.js.in" \
sed -e "s/{datetime}/${datetime}/" "${DIRNAME}/style_template/footer.js.in" \
| sed -e "s/{year}/${year}/" \
| sed -e "s/{projectName}/${projectName}/" \
| sed -e "s/{projectNumber}/${projectNumber}/" \
Expand Down
15 changes: 15 additions & 0 deletions Documentation/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# CMSIS-DAP Documentation

CMSIS-DAP documentation in HTML format is published online at [https://arm-software.github.io/CMSIS-DAP](https://arm-software.github.io/CMSIS-DAP).

The version drop-down menu there allows to switch between the documentation provided with offical releases and the latest draft documentation for the main branch.

The documentation source is maintained in `Documentation/Doxygen/` folder as a mixture of markdown and doxygen formats. Component source files, templates and examples may also contribute information that gets integrated into the final documentation.

Generating the HTML-formatted documentation from the source is done with `gen_doc.sh` script:

```sh
CMSIS-DAP $ ./Documentation/Doxygen/gen_doc.sh
```

The script expects specific version of [doxygen](https://www.doxygen.nl/) to be installed locally. After successful execution the resulting documentation package is then available in `./Documentation/html/`.

0 comments on commit 76fd796

Please sign in to comment.