JSONCrack for Sphinx Extension

Welcome to the documentation for the JSONCrack for Sphinx Extension.

This extension automatically integrates JSON schema documentation into your Sphinx documentation, using the jsoncrack.com library to generate beautiful, interactive HTML representations.

Getting Started:

• Installation
  • Requirements
  • Install from PyPI
  • Install from Source
  • Development Installation
• Quick Start Guide
  • Installation
  • Configuration
  • Basic Usage
  • Next Steps

User Guide:

• Configuration
  • Global Configuration
  • Schema Directive Options
  • File Naming Conventions
  • Schema Search Policy
  • Advanced Configuration
  • Detailed Search Patterns Analysis
• Search Patterns Analysis
  • Object Structure
  • All Possible SearchPolicy Combinations
  • Summary Table of Combinations
  • Usage Recommendations
  • Practical Examples
  • Schema Search Debugging
• Usage Guide
  • Automatic Schema Inclusion
  • Manual Schema Inclusion
  • Layout Options
  • Theme Integration
  • Working with Multiple Schemas
  • Best Practices
  • Troubleshooting
• Examples
  • Automatic Schema Documentation
  • Manual Schema Inclusion
  • Schema Files
  • Advanced Search Policy Examples

Reference:

• API Reference
  • Extension Module
  • Configuration Module
  • Utilities Module
  • Fixtures Module
• Changelog
  • [Unreleased]
  • [0.1.0] - 2025-07-18

Development:

• Development Guide
  • Setting Up Development Environment
  • Running Tests
  • Building Documentation
  • Project Structure
  • Code Style
  • Testing Guidelines
  • Contributing
  • Release Process
  • Debugging

Features

• 🔄 Automatic schema inclusion: Schemas are automatically included in autodoc-generated documentation

• 📁 Flexible file naming: Support for multiple naming conventions

• 🎨 Beautiful rendering: Uses jsoncrack.com for rich HTML output

• 🔧 Manual inclusion: schema directive for manual schema inclusion

• 🧪 Testing support: Fixtures for testing schema documentation

• 🌙 Dark mode: Support for dark theme styling

• ⚡ Performance: Optimized rendering with lazy loading

• 📖 Rich documentation: Comprehensive guides and examples

Quick Start

1. Install the extension:

pip install jsoncrack-for-sphinx

2. Add to your conf.py:

extensions = ['jsoncrack_for_sphinx']

3. Use in your documentation:

.. schema:: user_schema
   :title: User Schema
   :description: Schema for user data

Getting Help

• Check the Quick Start Guide guide for quick setup

• Read the Usage Guide guide for detailed examples

• Browse the API Reference reference for technical details

• Report issues on GitHub

Indices and Tables

• Index

• Module Index

• Search Page

Indices and tables

• Index

• Module Index

• Search Page