📖 Sphinx Documentation Portal
Sphinx Hub
Full project portal: architecture, API reference, testing strategy, CI/CD guide, and Sphinx 101.
Sphinx
Documentation PDF
Full Sphinx documentation exported as PDF for offline reading.
PDF
Sphinx 101
What Sphinx is, how to use it, and how to integrate it with GitHub Actions.
Guide
Architecture
MVC pattern, package structure, and key architectural decisions.
Sphinx
CI/CD Guide
GitHub Actions workflows explained in full detail.
Sphinx
🔌 Java API Reference
Javadoc
Standard Java API reference for all public classes, methods, and fields.
Javadoc
Doxygen
Cross-referenced HTML with call graphs and class hierarchies.
Doxygen
🧪 Test Reports
JaCoCo Coverage
Line, branch, and method coverage. Minimum threshold: 25% line coverage.
JaCoCo
Surefire — Unit Tests
Pass / fail / skipped for every JUnit 5 test case with execution times.
Surefire
Performance Tests
JUnitPerf throughput and latency results (performance Maven profile).
JUnitPerf
🔍 Code Quality
Checkstyle
Code style conformance: formatting, naming conventions, structural rules.
Checkstyle
PMD
Unused variables, empty catch blocks, overly complex methods.
PMD
CPD — Copy-Paste Detector
Identifies duplicated code blocks across the codebase.
CPD
JDepend
Coupling, cohesion, and instability metrics at the package level.
JDepend
🗂️ Full Maven Site