Skip to content

fnb v0.11.2 - ReadTheDocs Documentation Platform Integration

Release Date: 2025-08-25 Type: Patch Release Migration: No breaking changes

Release Highlights

This patch release establishes comprehensive ReadTheDocs integration for fnb, enabling versioned documentation publishing with automated builds from Git tags.

📖 ReadTheDocs Platform Integration

Complete setup of versioned documentation publishing:

  • Automated Version Builds - Documentation automatically builds for each Git tag
  • Multi-format Output - HTML, EPUB, and HTMLZip formats available
  • Material Theme Support - Full mkdocs-material theme compatibility with ReadTheDocs
  • Webhook Integration - Automatic builds triggered by GitLab pushes and tags

🔧 Configuration Enhancement

Enhanced project configuration for documentation platform compatibility:

  • Dependency Management - Added [project.optional-dependencies] for ReadTheDocs compatibility
  • Build Environment - Python 3.12 with optimized build configuration
  • Theme Dependencies - Proper mkdocs-material and plugin dependencies for cloud builds

🌐 Public Documentation Access

New public documentation infrastructure:

  • Version Selector - Users can switch between different versions seamlessly
  • Stable URLs - Each version available at predictable URLs (e.g., /en/0.11.2/)
  • Latest Documentation - Always-current documentation at /en/latest/
  • Search Integration - Full-text search across all versions and content

Technical Changes

Configuration Files

  • .readthedocs.yaml - New ReadTheDocs build configuration
  • pyproject.toml - Added docs optional dependencies group

Documentation Publishing

  • ReadTheDocs.org - Live documentation at https://fnb.readthedocs.io/
  • Version Management - Automatic version detection from Git tags
  • Build Pipeline - Integrated with existing task release-full workflow

Installation & Usage

No changes to installation or usage - this release only enhances documentation infrastructure.

# Installation remains the same
uv pip install fnb

# All commands work identically
fnb --help

Documentation Access

  • Latest Version: https://fnb.readthedocs.io/en/latest/
  • This Version: https://fnb.readthedocs.io/en/0.11.2/
  • All Versions: Available via version selector on any documentation page

Community Impact

  • Enhanced Onboarding - New users can access comprehensive, versioned documentation
  • Developer Experience - Contributors can reference version-specific API documentation
  • Professional Presentation - Clean, searchable documentation platform improves project credibility

Migration Guide

No migration required - this is purely an infrastructure enhancement that improves documentation access without affecting fnb's core functionality.

Resources

  • Documentation: https://fnb.readthedocs.io/
  • Release Notes: https://fnb.readthedocs.io/en/latest/releases/
  • Installation Guide: https://fnb.readthedocs.io/en/latest/usage/installation/
  • Configuration Guide: https://fnb.readthedocs.io/en/latest/usage/configuration/