Skip to content

Commit 23322cd

Browse files
dipinadipina
committed
deploy: acb8b20 
1 parent 0160903 commit 23322cd

2 files changed

Lines changed: 62 additions & 104 deletions

File tree

‎index.html‎

Lines changed: 62 additions & 104 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
<!DOCTYPE html>
22
<html lang="en">
33
<head>
4-
<meta charset="UTF-8" />
5-
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
6-
<title>SpringBootLibrary — Documentation Portal</title>
4+
<meta charset="UTF-8"/>
5+
<meta name="viewport" content="width=device-width, initial-scale=1.0"/>
6+
<title>SpringBootLibrarySphinx — Documentation Portal</title>
77
<style>
88
:root {
99
--brand: #2980b9;
@@ -24,15 +24,13 @@
2424
background: var(--light-bg);
2525
color: var(--text);
2626
}
27-
28-
/* ── Header ── */
2927
header {
3028
background: var(--dark);
3129
color: #fff;
3230
padding: 2.5rem 2rem 2rem;
3331
text-align: center;
3432
}
35-
header h1 { font-size: 2.2rem; font-weight: 700; letter-spacing: -0.5px; }
33+
header h1 { font-size: 2.2rem; font-weight: 700; }
3634
header p { margin-top: .6rem; color: #a8c0d6; font-size: 1.05rem; }
3735
.badge {
3836
display: inline-block;
@@ -43,15 +41,8 @@
4341
font-weight: 600;
4442
background: var(--brand);
4543
color: #fff;
46-
letter-spacing: .5px;
47-
}
48-
49-
/* ── Grid ── */
50-
main {
51-
max-width: 1100px;
52-
margin: 2.5rem auto;
53-
padding: 0 1.5rem 4rem;
5444
}
45+
main { max-width: 1100px; margin: 2.5rem auto; padding: 0 1.5rem 4rem; }
5546
.section-title {
5647
font-size: 1rem;
5748
font-weight: 700;
@@ -67,8 +58,6 @@
6758
grid-template-columns: repeat(auto-fill, minmax(280px, 1fr));
6859
gap: 1.2rem;
6960
}
70-
71-
/* ── Cards ── */
7261
.card {
7362
background: var(--card-bg);
7463
border: 1px solid var(--border);
@@ -86,19 +75,9 @@
8675
box-shadow: 0 6px 20px rgba(0,0,0,.1);
8776
border-color: var(--brand);
8877
}
89-
.card-icon {
90-
font-size: 1.8rem;
91-
line-height: 1;
92-
}
93-
.card-title {
94-
font-weight: 700;
95-
font-size: 1.05rem;
96-
}
97-
.card-desc {
98-
font-size: .88rem;
99-
color: var(--muted);
100-
line-height: 1.5;
101-
}
78+
.card-icon { font-size: 1.8rem; line-height: 1; }
79+
.card-title { font-weight: 700; font-size: 1.05rem; }
80+
.card-desc { font-size: .88rem; color: var(--muted); line-height: 1.5; }
10281
.card-tag {
10382
display: inline-block;
10483
font-size: .72rem;
@@ -109,15 +88,12 @@
10988
align-self: flex-start;
11089
margin-top: .3rem;
11190
}
112-
113-
/* Tag colours */
11491
.tag-sphinx { background: var(--brand); }
11592
.tag-java { background: var(--orange); }
11693
.tag-test { background: var(--green); }
11794
.tag-quality { background: var(--purple); }
11895
.tag-perf { background: var(--teal); }
11996
.tag-doxygen { background: #c0392b; }
120-
12197
footer {
12298
text-align: center;
12399
padding: 2rem;
@@ -130,146 +106,128 @@
130106
<body>
131107

132108
<header>
133-
<h1>📚 SpringBootLibrary</h1>
134-
<p>Documentation Portal — SPQ subject exemplary project</p>
135-
<span class="badge">Spring Boot 3.4 · Java 17 · CI/CD with GitHub Actions</span>
109+
<h1>&#x1F4DA; SpringBootLibrarySphinx</h1>
110+
<p>Documentation Portal &mdash; SPQ subject exemplary project</p>
111+
<span class="badge">Spring Boot 3.4 &middot; Java 17 &middot; CI/CD with GitHub Actions</span>
136112
</header>
137113

138114
<main>
139115

140-
<!-- ── Sphinx Portal ── -->
141-
<p class="section-title">📖 Documentation Portal (Sphinx)</p>
116+
<p class="section-title">&#x1F4D6; Sphinx Documentation Portal</p>
142117
<div class="grid">
143-
144118
<a class="card" href="sphinx/index.html">
145-
<span class="card-icon">🏠</span>
146-
<span class="card-title">Sphinx Documentation Hub</span>
119+
<span class="card-icon">&#x1F3E0;</span>
120+
<span class="card-title">Sphinx Hub</span>
147121
<span class="card-desc">Full project portal: architecture, API reference, testing strategy, CI/CD guide, and Sphinx 101.</span>
148122
<span class="card-tag tag-sphinx">Sphinx</span>
149123
</a>
150-
124+
<a class="card" href="sphinx/SpringBootLibrarySphinx.pdf">
125+
<span class="card-icon">&#x1F4C4;</span>
126+
<span class="card-title">Documentation PDF</span>
127+
<span class="card-desc">Full Sphinx documentation exported as PDF for offline reading.</span>
128+
<span class="card-tag tag-sphinx">PDF</span>
129+
</a>
151130
<a class="card" href="sphinx/sphinx_101.html">
152-
<span class="card-icon">📘</span>
131+
<span class="card-icon">&#x1F4D8;</span>
153132
<span class="card-title">Sphinx 101</span>
154-
<span class="card-desc">What Sphinx is, what it's useful for, how to use it, and how to integrate it with GitHub Actions.</span>
155-
<span class="card-tag tag-sphinx">Sphinx Guide</span>
133+
<span class="card-desc">What Sphinx is, how to use it, and how to integrate it with GitHub Actions.</span>
134+
<span class="card-tag tag-sphinx">Guide</span>
156135
</a>
157-
158136
<a class="card" href="sphinx/architecture.html">
159-
<span class="card-icon">🏗️</span>
160-
<span class="card-title">Architecture Overview</span>
161-
<span class="card-desc">MVC pattern, package structure, database design, and key architectural decisions.</span>
137+
<span class="card-icon">&#x1F3D7;&#xFE0F;</span>
138+
<span class="card-title">Architecture</span>
139+
<span class="card-desc">MVC pattern, package structure, and key architectural decisions.</span>
162140
<span class="card-tag tag-sphinx">Sphinx</span>
163141
</a>
164-
165142
<a class="card" href="sphinx/cicd.html">
166-
<span class="card-icon">🚀</span>
143+
<span class="card-icon">&#x1F680;</span>
167144
<span class="card-title">CI/CD Guide</span>
168-
<span class="card-desc">GitHub Actions workflows explained: Maven site, Sphinx deployment, and GitHub Pages setup.</span>
145+
<span class="card-desc">GitHub Actions workflows explained in full detail.</span>
169146
<span class="card-tag tag-sphinx">Sphinx</span>
170147
</a>
171-
172148
</div>
173149

174-
<!-- ── Java API Reference ── -->
175-
<p class="section-title">🔌 Java API Reference</p>
150+
<p class="section-title">&#x1F50C; Java API Reference</p>
176151
<div class="grid">
177-
178152
<a class="card" href="site/apidocs/index.html">
179-
<span class="card-icon">☕</span>
153+
<span class="card-icon">&#x2615;</span>
180154
<span class="card-title">Javadoc</span>
181-
<span class="card-desc">Standard Java API reference for all public classes, methods, and fields. Generated by maven-javadoc-plugin.</span>
155+
<span class="card-desc">Standard Java API reference for all public classes, methods, and fields.</span>
182156
<span class="card-tag tag-java">Javadoc</span>
183157
</a>
184-
185158
<a class="card" href="doxygen/html/index.html">
186-
<span class="card-icon">🔬</span>
187-
<span class="card-title">Doxygen Reference</span>
188-
<span class="card-desc">Cross-referenced HTML with call graphs and class hierarchies. Includes richly documented classes: BorrowingController, BookService, Borrowing.</span>
159+
<span class="card-icon">&#x1F52C;</span>
160+
<span class="card-title">Doxygen</span>
161+
<span class="card-desc">Cross-referenced HTML with call graphs and class hierarchies.</span>
189162
<span class="card-tag tag-doxygen">Doxygen</span>
190163
</a>
191-
192164
</div>
193165

194-
<!-- ── Test Reports ── -->
195-
<p class="section-title">🧪 Test Reports</p>
166+
<p class="section-title">&#x1F9EA; Test Reports</p>
196167
<div class="grid">
197-
198168
<a class="card" href="site/jacoco/index.html">
199-
<span class="card-icon">📊</span>
169+
<span class="card-icon">&#x1F4CA;</span>
200170
<span class="card-title">JaCoCo Coverage</span>
201-
<span class="card-desc">Line, branch, and method coverage report. Minimum threshold enforced: 25 % line coverage.</span>
171+
<span class="card-desc">Line, branch, and method coverage. Minimum threshold: 25% line coverage.</span>
202172
<span class="card-tag tag-test">JaCoCo</span>
203173
</a>
204-
205-
<a class="card" href="site/surefire-report.html">
206-
<span class="card-icon">✅</span>
207-
<span class="card-title">Surefire — Unit Tests</span>
208-
<span class="card-desc">Pass / fail / skipped results for every JUnit 5 unit test case, with execution times.</span>
174+
<a class="card" href="site/surefire.html">
175+
<span class="card-icon">&#x2705;</span>
176+
<span class="card-title">Surefire &mdash; Unit Tests</span>
177+
<span class="card-desc">Pass / fail / skipped for every JUnit 5 test case with execution times.</span>
209178
<span class="card-tag tag-test">Surefire</span>
210179
</a>
211-
212180
<a class="card" href="site/reports/perf-report.html">
213-
<span class="card-icon">⚡</span>
181+
<span class="card-icon">&#x26A1;</span>
214182
<span class="card-title">Performance Tests</span>
215-
<span class="card-desc">JUnitPerf throughput and latency results. Generated with the `performance` Maven profile.</span>
183+
<span class="card-desc">JUnitPerf throughput and latency results (performance Maven profile).</span>
216184
<span class="card-tag tag-perf">JUnitPerf</span>
217185
</a>
218-
219186
</div>
220187

221-
<!-- ── Code Quality ── -->
222-
<p class="section-title">🔍 Code Quality Reports</p>
188+
<p class="section-title">&#x1F50D; Code Quality</p>
223189
<div class="grid">
224-
225190
<a class="card" href="site/checkstyle.html">
226-
<span class="card-icon">📏</span>
191+
<span class="card-icon">&#x1F4CF;</span>
227192
<span class="card-title">Checkstyle</span>
228-
<span class="card-desc">Code style conformance report. Validates formatting, naming conventions, and structural rules.</span>
193+
<span class="card-desc">Code style conformance: formatting, naming conventions, structural rules.</span>
229194
<span class="card-tag tag-quality">Checkstyle</span>
230195
</a>
231-
232196
<a class="card" href="site/pmd.html">
233-
<span class="card-icon">🐛</span>
234-
<span class="card-title">PMD — Static Analysis</span>
235-
<span class="card-desc">Detects unused variables, empty catch blocks, overly complex methods, and other code smells.</span>
197+
<span class="card-icon">&#x1F41B;</span>
198+
<span class="card-title">PMD</span>
199+
<span class="card-desc">Unused variables, empty catch blocks, overly complex methods.</span>
236200
<span class="card-tag tag-quality">PMD</span>
237201
</a>
238-
239202
<a class="card" href="site/cpd.html">
240-
<span class="card-icon">📋</span>
241-
<span class="card-title">CPD — Copy-Paste Detector</span>
242-
<span class="card-desc">Identifies duplicated code blocks across the entire codebase.</span>
243-
<span class="card-tag tag-quality">PMD/CPD</span>
203+
<span class="card-icon">&#x1F4CB;</span>
204+
<span class="card-title">CPD &mdash; Copy-Paste Detector</span>
205+
<span class="card-desc">Identifies duplicated code blocks across the codebase.</span>
206+
<span class="card-tag tag-quality">CPD</span>
244207
</a>
245-
246208
<a class="card" href="site/jdepend-report.html">
247-
<span class="card-icon">📐</span>
248-
<span class="card-title">JDepend — Package Metrics</span>
249-
<span class="card-desc">Coupling, cohesion, and instability metrics at the package level. Useful for spotting architectural drift.</span>
209+
<span class="card-icon">&#x1F4D0;</span>
210+
<span class="card-title">JDepend</span>
211+
<span class="card-desc">Coupling, cohesion, and instability metrics at the package level.</span>
250212
<span class="card-tag tag-quality">JDepend</span>
251213
</a>
252-
253214
</div>
254215

255-
<!-- ── Full Maven Site ── -->
256-
<p class="section-title">🗂️ Full Maven Site</p>
216+
<p class="section-title">&#x1F5C2;&#xFE0F; Full Maven Site</p>
257217
<div class="grid">
258-
259218
<a class="card" href="site/index.html">
260-
<span class="card-icon">📑</span>
261-
<span class="card-title">Maven Site (complete)</span>
262-
<span class="card-desc">Complete Maven-generated site with all plugins, project info, dependency reports, and more.</span>
219+
<span class="card-icon">&#x1F4D1;</span>
220+
<span class="card-title">Maven Site</span>
221+
<span class="card-desc">Complete Maven-generated site with all plugins, project info, and dependency reports.</span>
263222
<span class="card-tag tag-java">Maven</span>
264223
</a>
265-
266224
</div>
267225

268226
</main>
269227

270228
<footer>
271-
SpringBootLibrary · SPQ subject · Generated by GitHub Actions ·
272-
<a href="https://github.com/dipina/SpringBootLibrary" style="color:var(--brand)">GitHub Repository</a>
229+
SpringBootLibrarySphinx &middot; SPQ subject &middot; Generated by GitHub Actions &middot;
230+
<a href="https://github.com/dipina/SpringBootLibrarySphinx" style="color: var(--brand)">GitHub Repository</a>
273231
</footer>
274232

275233
</body>

‎sphinx/SpringBootLibrarySphinx.pdf‎

-2 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)