SpringBootLibrarySphinx

📖 Project Overview

  • Project Overview
    • Purpose
    • Key Features
    • Live Documentation Links
    • Repository Structure
  • Architecture
    • MVC Pattern
    • Package Structure
    • Key Design Decisions
    • Static Resources
  • Getting Started
    • Prerequisites
    • Database Setup
    • Running the Application
    • Running with Docker
    • Quick Reference: Maven Commands

🧪 Testing & Quality

  • Testing Strategy
    • Unit Tests
    • Integration Tests
    • Performance Tests
    • Code Coverage
    • Static Analysis
  • Test & Quality Reports
    • Javadoc API Reference
    • JaCoCo — Code Coverage
    • Surefire — Unit Test Report
    • Performance Tests
    • Checkstyle
    • PMD — Static Analysis
    • JDepend — Package Metrics
    • Doxygen
    • Complete path map
    • Generating All Reports Locally

🔌 API Reference

  • REST API Reference
    • Swagger UI (Live)
    • Endpoints Summary
      • Books
      • Users
      • Borrowings
    • Request / Response Examples
      • Borrow a book
      • Return a book
  • Javadoc API Documentation
    • Why Javadoc was missing — and the fix
    • Key Documented Classes
    • Generating Javadoc Locally
    • Javadoc vs Doxygen

🚀 DevOps & CI/CD

  • CI/CD with GitHub Actions
    • Workflow 1: maven-site-integration.yml
    • Workflow 2: sphinx-docs.yml
    • GitHub Pages Setup
    • Triggering Workflows via API
  • Docker & Docker Compose
    • Quick Start
    • Dockerfile
    • docker-compose.yml
    • VisualVM Profiling

📚 External Tools

  • Sphinx 101 — Complete Guide
    • What Is Sphinx?
    • What Is Sphinx Useful For?
      • Sphinx vs. Alternatives
    • How Is Sphinx Used?
      • 1. Install Sphinx
      • 2. Initialise a Project
      • 3. Source File Structure
      • 4. The toctree Directive
      • 5. Build the Documentation
      • 6. Key reStructuredText Syntax
      • 7. Markdown with MyST
    • How to Integrate Sphinx with GitHub Actions
      • Required Repository Settings
    • How This Project Uses Sphinx
      • Documentation Architecture
      • Integration Points
      • Adding a New Documentation Page
      • Adding the conf.py Extensions for This Project
    • Useful Sphinx Resources
SpringBootLibrarySphinx
  • Search

© Copyright 2026, dipina.

Built with Sphinx using a theme provided by Read the Docs.