Skip to content

Commit bfa7d02

Browse files
2bndy52bndy5
committed
docs: revise CI
corresponds to nRF24/.github#23 But really this repo just uses CI to deploy docs. So, I updated the docs sources to work better with doxygen v1.15.0 And I found/fixed a typo.
1 parent 8c28d55 commit bfa7d02

14 files changed

Lines changed: 306 additions & 72 deletions

‎.gitattributes‎

Lines changed: 28 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,30 @@
1-
# Auto detect text files and perform LF normalization
1+
# Set the default behavior, in case people don't have core.autocrlf set.
22
* text=auto
33

4-
# Custom for Visual Studio
5-
*.cs diff=csharp
6-
*.sln merge=union
7-
*.csproj merge=union
8-
*.vbproj merge=union
9-
*.fsproj merge=union
10-
*.dbproj merge=union
11-
12-
# Standard to msysgit
13-
*.doc diff=astextplain
14-
*.DOC diff=astextplain
15-
*.docx diff=astextplain
16-
*.DOCX diff=astextplain
17-
*.dot diff=astextplain
18-
*.DOT diff=astextplain
19-
*.pdf diff=astextplain
20-
*.PDF diff=astextplain
21-
*.rtf diff=astextplain
22-
*.RTF diff=astextplain
23-
24-
# doxygen generated files
25-
docs/html/
26-
docs/xml/
4+
# Explicitly declare text files you want to always be normalized and converted
5+
# to native line endings on checkout.
6+
*.py text eol=lf
7+
*.rst text eol=lf
8+
*.sh text eol=lf
9+
*.h text eol=lf
10+
*.cpp text eol=lf
11+
*.c text eol=lf
12+
.yaml text eol=lf
13+
*.yml text eol=lf
14+
*.md text eol=lf
15+
*.txt text eol=lf
16+
*.json text eol=lf
17+
*.properties text eol=lf
18+
LICENSE text eol=lf
19+
nurfile text eol=lf
20+
.gitignore text eol=lf
21+
.gitattributes text eol=lf
22+
.clang-format text eol=lf
23+
.clang-tidy text eol=lf
24+
Makefile text eol=lf
25+
*.svg text eol=lf
26+
*.ino text eol=lf
27+
*.dot text eol=lf
28+
*.cmake text eol=lf
29+
*.css text eol=lf
30+
Doxyfile text eol=lf

‎.github/workflows/doxygen.yml‎

Lines changed: 24 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,32 @@
1-
name: DoxyGen build
1+
name: Docs
22

33
on:
44
pull_request:
5-
branches:
6-
- master
5+
branches: [master]
76
push:
8-
branches:
9-
- master
7+
branches: [master]
8+
tags: ["*"]
9+
workflow_dispatch:
10+
11+
permissions: {}
12+
13+
concurrency:
14+
group: ${{ github.workflow }}-${{ github.ref }}
15+
cancel-in-progress: ${{ github.ref != 'refs/heads/master' }}
1016

1117
jobs:
12-
build-docs:
13-
uses: nRF24/.github/.github/workflows/build_docs.yaml@main
18+
build:
19+
uses: nRF24/.github/.github/workflows/build_docs.yaml@review-ci
1420
with:
15-
deploy-gh-pages: ${{ github.event_name == 'push' }} # happens only on master branch
21+
doxygen-version: "1.15.0"
22+
23+
deploy:
24+
needs: [build]
25+
if: github.ref == 'refs/heads/master' || startsWith(github.ref, 'refs/tags/')
26+
permissions:
27+
# to authenticate the gh-pages environment
28+
id-token: write
29+
# to upload to GitHub Pages
30+
pages: write
31+
uses: nRF24/.github/.github/workflows/deploy_docs.yaml@review-ci
1632
secrets: inherit

‎README.md‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,3 @@ See the [documentation section](http://nRF24.github.io/RF24Audio) for more info.
55

66
Only AVR devices are supported. For ESP32 and Arduino Due, see [AutoAnalogAudio](https://github.com/TMRh20/AutoAnalogAudio), a more
77
versatile audio input/output library.
8-
9-

‎RF24Audio.h‎

Lines changed: 1 addition & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ class RF24Audio
106106
* Get any of the preset radio addresses
107107
*
108108
* Useful for listening nodes who wish to create private or additional radio groups
109-
* The library has 14 predefined radio addreses. All radios listen/write on the first
109+
* The library has 14 predefined radio addresses. All radios listen/write on the first
110110
* two addresses (0, 1), and engage a private channel based on the radio number.
111111
* Radio 0 listens on address 2, Radio 1 on address 3, etc.
112112
*
@@ -172,18 +172,3 @@ void RX();
172172
* This sketch is demonstrates how to interact with the audio library directly using the core
173173
* RF24 radio library: http://nRF24.github.io/RF24/
174174
*/
175-
176-
/**
177-
* @page Setup Boards & Wiring
178-
* @section Board Wiring
179-
* This page displays different options for wiring/board configuration.
180-
*
181-
* @image html "images/NRF1.jpg" height=25% width=25%
182-
*
183-
* Wiring diagram for DIY module connector. May not be needed depending on module:
184-
* @image html "images/RF24AudioBasic_LargeAntenna.jpg" height=45% width=45%
185-
* @image html "images/NRF2.jpg" height=20% width=20%
186-
* @image html "images/RF24AudioBasic_SmallAntenna.jpg" height=45% width=45%
187-
* Wiring diagram for SD streaming/multicast using TMRpcm library:
188-
* @image html "images/RF24Audio_FullSD.jpg" height=65% width=65%
189-
*/

‎docs/Doxyfile‎

Lines changed: 38 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@
1717
# Project related configuration options
1818
#---------------------------------------------------------------------------
1919

20+
PROJECT_ICON = images/favicon.ico
21+
2022
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
2123
# double-quotes, unless you are using Doxywizard) that should identify the
2224
# project for which the documentation is generated. This name is used in the
@@ -165,7 +167,7 @@ EXAMPLE_RECURSIVE = YES
165167
# that contain images that are to be included in the documentation (see the
166168
# \image command).
167169

168-
IMAGE_PATH = ../images
170+
IMAGE_PATH = ./images/
169171

170172
# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
171173
# is part of the input, its contents will be placed on the main page
@@ -174,6 +176,12 @@ IMAGE_PATH = ../images
174176

175177
USE_MDFILE_AS_MAINPAGE = main_page.md
176178

179+
# Don't display the ugly/complicated "tree view" side menu.
180+
# And, restore the top (simpler) navigation bar.
181+
# As of doxygen v1.13.0, these default values changed from NO to YES
182+
GENERATE_TREEVIEW = NO
183+
DISABLE_INDEX = NO
184+
177185
#---------------------------------------------------------------------------
178186
# Configuration options related to source browsing
179187
#---------------------------------------------------------------------------
@@ -232,6 +240,35 @@ HTML_EXTRA_STYLESHEET = doxygen-custom.css
232240

233241
HTML_COLORSTYLE = TOGGLE
234242

243+
# If the TIMESTAMP tag is set different from NO then each generated page will contain
244+
# the date or date and time when the page was generated. Setting this to NO can help
245+
# when comparing the output of multiple runs.
246+
#
247+
# Possible values are: YES, NO, DATETIME and DATE.
248+
#
249+
# The default value is: NO.
250+
251+
TIMESTAMP = DATE
252+
253+
# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML
254+
# documentation will contain a main index with vertical navigation menus that
255+
# are dynamically created via JavaScript. If disabled, the navigation index will
256+
# consists of multiple levels of tabs that are statically embedded in every HTML
257+
# page. Disable this option to support browsers that do not have JavaScript,
258+
# like the Qt help browser.
259+
# The default value is: YES.
260+
# This tag requires that the tag GENERATE_HTML is set to YES.
261+
262+
HTML_DYNAMIC_MENUS = NO
263+
264+
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
265+
# documentation will contain sections that can be hidden and shown after the
266+
# page has loaded.
267+
# The default value is: NO.
268+
# This tag requires that the tag GENERATE_HTML is set to YES.
269+
270+
HTML_DYNAMIC_SECTIONS = YES
271+
235272
#---------------------------------------------------------------------------
236273
# Configuration options related to the LaTeX output
237274
#---------------------------------------------------------------------------

‎docs/doxygen-custom.css‎

Lines changed: 163 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,166 @@
11
table.markdownTable th {
22
color: unset;
33
}
4+
5+
/* overrides from default CSS for some admonitions */
6+
dl.note,
7+
dl.remark,
8+
dl.warning,
9+
dl.attention,
10+
dl.important,
11+
dl.deprecated,
12+
dl.see {
13+
color: unset;
14+
box-shadow: 5px 5px 5px hsla(0, 0%, 19.2%, 0.5);
15+
}
16+
17+
dl.remark {
18+
background: var(--remark-color-bg);
19+
border-left: 8px solid var(--remark-color-hl);
20+
}
21+
22+
dl.remark dt {
23+
color: var(--remark-color-hl);
24+
}
25+
26+
dl.important dt {
27+
color: var(--important-color-hl);
28+
}
29+
30+
dl.important {
31+
background: var(--important-color-bg);
32+
border-left: 8px solid var(--important-color-hl);
33+
}
34+
35+
dl.attention dt {
36+
color: var(--attention-color-hl);
37+
}
38+
39+
dl.attention {
40+
background: var(--attention-color-bg);
41+
border-left: 8px solid var(--attention-color-hl);
42+
}
43+
44+
dl.deprecated dt {
45+
color: var(--deprecated-color-hl);
46+
}
47+
48+
dl.deprecated {
49+
background: var(--deprecated-color-bg);
50+
border-left: 8px solid var(--deprecated-color-hl);
51+
}
52+
53+
/* special rules to accent `/see` or `/sa` command output */
54+
dl.see {
55+
background: var(--seealso-color-bg);
56+
border-left: 8px solid var(--seealso-color-hl);
57+
}
58+
59+
dl.see dt {
60+
color: var(--seealso-color-hl);
61+
}
62+
63+
dl.see {
64+
padding: 10px;
65+
margin: 10px 0px;
66+
overflow: hidden;
67+
margin-left: 0;
68+
border-radius: 4px;
69+
}
70+
71+
dl.see dd {
72+
margin-left: 0;
73+
}
74+
75+
/* admonition icons */
76+
dl.note dt::before {
77+
background-color: var(--note-color-hl);
78+
mask-image: var(--note-icon);
79+
}
80+
81+
dl.see dt::before {
82+
background-color: var(--seealso-color-hl);
83+
mask-image: var(--seealso-icon);
84+
}
85+
86+
dl.remark dt::before {
87+
background-color: var(--remark-color-hl);
88+
mask-image: var(--remark-icon);
89+
}
90+
91+
dl.warning dt::before {
92+
background-color: var(--warning-color-hl);
93+
mask-image: var(--warning-icon);
94+
}
95+
96+
dl.deprecated dt::before {
97+
background-color: var(--deprecated-color-hl);
98+
mask-image: var(--deprecated-icon);
99+
}
100+
101+
dl.important dt::before {
102+
background-color: var(--important-color-hl);
103+
mask-image: var(--important-icon);
104+
}
105+
106+
dl.attention dt::before {
107+
background-color: var(--attention-color-hl);
108+
mask-image: var(--attention-icon);
109+
}
110+
111+
dl.note dt::before,
112+
dl.see dt::before,
113+
dl.warning dt::before,
114+
dl.remark dt::before,
115+
dl.deprecated dt::before,
116+
dl.important dt::before,
117+
dl.attention dt::before {
118+
vertical-align: middle;
119+
background-repeat: no-repeat;
120+
content: "";
121+
display: inline-block;
122+
height: 2em;
123+
width: 2em;
124+
margin-right: 0.25rem;
125+
}
126+
127+
dl.note dt,
128+
dl.see dt,
129+
dl.warning dt,
130+
dl.remark dt,
131+
dl.deprecated dt,
132+
dl.important dt,
133+
dl.attention dt {
134+
margin-top: -0.35em;
135+
margin-bottom: 0.5em;
136+
}
137+
138+
/* icon SVG data */
139+
*:root {
140+
--note-icon: url('data:image/svg+xml;utf8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 -960 960 960"><path d="M480-280q17 0 28.5-11.5T520-320v-160q0-17-11.5-28.5T480-520q-17 0-28.5 11.5T440-480v160q0 17 11.5 28.5T480-280Zm0-320q17 0 28.5-11.5T520-640q0-17-11.5-28.5T480-680q-17 0-28.5 11.5T440-640q0 17 11.5 28.5T480-600Zm0 520q-83 0-156-31.5T197-197q-54-54-85.5-127T80-480q0-83 31.5-156T197-763q54-54 127-85.5T480-880q83 0 156 31.5T763-763q54 54 85.5 127T880-480q0 83-31.5 156T763-197q-54 54-127 85.5T480-80Zm0-80q134 0 227-93t93-227q0-134-93-227t-227-93q-134 0-227 93t-93 227q0 134 93 227t227 93Zm0-320Z"/></svg>');
141+
--warning-icon: url('data:image/svg+xml;utf8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 -960 960 960"><path d="m40-120 440-760 440 760H40Zm138-80h604L480-720 178-200Zm302-40q17 0 28.5-11.5T520-280q0-17-11.5-28.5T480-320q-17 0-28.5 11.5T440-280q0 17 11.5 28.5T480-240Zm-40-120h80v-200h-80v200Zm40-100Z"/></svg>');
142+
--remark-icon: url('data:image/svg+xml;utf8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 -960 960 960"><path d="M480-80q-33 0-56.5-23.5T400-160h160q0 33-23.5 56.5T480-80ZM360-200q-17 0-28.5-11.5T320-240q0-17 11.5-28.5T360-280h240q17 0 28.5 11.5T640-240q0 17-11.5 28.5T600-200H360Zm-30-120q-69-41-109.5-110T180-580q0-125 87.5-212.5T480-880q125 0 212.5 87.5T780-580q0 81-40.5 150T630-320H330Zm24-80h252q45-32 69.5-79T700-580q0-92-64-156t-156-64q-92 0-156 64t-64 156q0 54 24.5 101t69.5 79Zm126 0Z"/></svg>');
143+
--attention-icon: url('data:image/svg+xml;utf8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 -960 960 960"><path d="M480-280q17 0 28.5-11.5T520-320q0-17-11.5-28.5T480-360q-17 0-28.5 11.5T440-320q0 17 11.5 28.5T480-280Zm0-160q17 0 28.5-11.5T520-480v-160q0-17-11.5-28.5T480-680q-17 0-28.5 11.5T440-640v160q0 17 11.5 28.5T480-440ZM363-120q-16 0-30.5-6T307-143L143-307q-11-11-17-25.5t-6-30.5v-234q0-16 6-30.5t17-25.5l164-164q11-11 25.5-17t30.5-6h234q16 0 30.5 6t25.5 17l164 164q11 11 17 25.5t6 30.5v234q0 16-6 30.5T817-307L653-143q-11 11-25.5 17t-30.5 6H363Zm1-80h232l164-164v-232L596-760H364L200-596v232l164 164Zm116-280Z"/></svg>');
144+
--important-icon: url('data:image/svg+xml;utf8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 -960 960 960"><path d="M480-360q17 0 28.5-11.5T520-400q0-17-11.5-28.5T480-440q-17 0-28.5 11.5T440-400q0 17 11.5 28.5T480-360Zm0-160q17 0 28.5-11.5T520-560v-160q0-17-11.5-28.5T480-760q-17 0-28.5 11.5T440-720v160q0 17 11.5 28.5T480-520ZM240-240l-92 92q-19 19-43.5 8.5T80-177v-623q0-33 23.5-56.5T160-880h640q33 0 56.5 23.5T880-800v480q0 33-23.5 56.5T800-240H240Zm-34-80h594v-480H160v525l46-45Zm-46 0v-480 480Z"/></svg>');
145+
--seealso-icon: url('data:image/svg+xml;utf8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 -960 960 960"><path d="M480-320q75 0 127.5-52.5T660-500q0-75-52.5-127.5T480-680q-75 0-127.5 52.5T300-500q0 75 52.5 127.5T480-320Zm0-72q-45 0-76.5-31.5T372-500q0-45 31.5-76.5T480-608q45 0 76.5 31.5T588-500q0 45-31.5 76.5T480-392Zm0 192q-146 0-266-81.5T40-500q54-137 174-218.5T480-800q146 0 266 81.5T920-500q-54 137-174 218.5T480-200Zm0-300Zm0 220q113 0 207.5-59.5T832-500q-50-101-144.5-160.5T480-720q-113 0-207.5 59.5T128-500q50 101 144.5 160.5T480-280Z"/></svg>');
146+
--deprecated-icon: url('data:image/svg+xml;utf8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 -960 960 960"><path d="M280-120q-33 0-56.5-23.5T200-200v-520h-40v-80h200v-40h240v40h200v80h-40v520q0 33-23.5 56.5T680-120H280Zm400-600H280v520h400v-520ZM360-280h80v-360h-80v360Zm160 0h80v-360h-80v360ZM280-720v520-520Z"/></svg>');
147+
}
148+
149+
/* color overrides */
150+
html,
151+
html.dark-mode {
152+
--note-color-hl: hsl(213.7, 92.8%, 62%);
153+
--note-color-bg: hsla(213.7, 92.8%, 62%, 12.5%);
154+
--warning-color-hl: hsl(40.6, 72.1%, 47.8%);
155+
--warning-color-bg: hsla(40.6, 72.1%, 47.8%, 12.5%);
156+
--attention-color-hl: hsl(2.7, 92.6%, 62.9%);
157+
--attention-color-bg: hsla(2.7, 92.6%, 62.9%, 12.5%);
158+
--deprecated-color-hl: hsl(0, 0%, 47%);
159+
--deprecated-color-bg: hsla(0, 0%, 47%, 12.5%);
160+
--seealso-color-hl: hsl(323, 72%, 52%);
161+
--seealso-color-bg: hsla(323, 72%, 52%, 12.5%);
162+
--remark-color-hl: hsl(128.4, 49.2%, 48.6%);
163+
--remark-color-bg: hsla(128.4, 49.2%, 48.6%, 12.5%);
164+
--important-color-hl: hsl(262.4, 89.8%, 73.1%);
165+
--important-color-bg: hsla(262.4, 89.8%, 73.1%, 12.5%);
166+
}

images/NRF1.jpg renamed to docs/images/NRF1.jpg

File renamed without changes.

images/NRF2.jpg renamed to docs/images/NRF2.jpg

File renamed without changes.

images/RF24AudioBasic_LargeAntenna.jpg renamed to docs/images/RF24AudioBasic_LargeAntenna.jpg

File renamed without changes.

images/RF24AudioBasic_SmallAntenna.jpg renamed to docs/images/RF24AudioBasic_SmallAntenna.jpg

File renamed without changes.

0 commit comments

Comments
 (0)