AccessibleDjango

Contents

  • Installation
    • Requirements
    • Installation Methods
      • Using pip
      • Using uv (Recommended for Development)
      • From Source
    • Configuration
      • 1. Add to Installed Apps
      • 2. Verify Installation
    • Optional Configuration
      • Template Directories
      • Development vs Production
    • Upgrading
    • Troubleshooting
      • Check Not Running
      • Import Errors
    • Next Steps
  • Quick Start Guide
    • Installation
    • Your First Accessibility Check
      • 1. Create a Template with Issues
      • 2. Run the Accessibility Check
      • 3. Fix the Issues
      • 4. Verify the Fixes
    • Integration with Development Workflow
      • During Development
      • In CI/CD Pipelines
      • Pre-commit Hooks
    • Understanding Alt Text
      • When to Use Alt Text
      • Decorative Images
      • Functional Images
    • Common Patterns
      • Logo Images
      • Product Images
      • Avatar Images
      • Charts and Graphs
    • Next Steps
    • Getting Help
  • User Guide
    • Overview
    • How It Works
      • System Check Integration
      • Template Scanning
      • Issue Detection
    • Running Checks
      • Manual Checks
      • Automatic Checks
    • Understanding Check Results
      • Warning Format
      • Check IDs
    • Writing Accessible Alt Text
      • General Guidelines
      • Examples by Use Case
        • Informative Images
        • Decorative Images
        • Functional Images
        • Complex Images
        • Text in Images
    • Best Practices
      • 1. Fix Issues Early
      • 2. Use Pre-commit Hooks
      • 3. Integrate with CI/CD
      • 4. Document Exceptions
      • 5. Team Education
    • Advanced Usage
      • Custom Template Directories
      • Silencing Specific Checks
      • Programmatic Access
    • Troubleshooting
      • Checks Not Running
      • False Positives
      • Performance Issues
      • Template Not Found Errors
    • Migration Guide
      • From Manual Testing
      • From Other Tools
    • Future Features
    • Getting Help
    • Next Steps
  • Contributing to AccessibleDjango
    • Quick Links
    • Overview
    • Getting Started
      • Prerequisites
      • Quick Setup
    • Development Workflow
      • 1. Create a Branch
      • 2. Make Changes
      • 3. Run Quality Checks
      • 4. Submit Pull Request
    • Code Standards
    • Testing
    • Documentation
    • Questions?
  • Changelog
    • Version History
      • [1.0.0] - 2024-12-25
        • Added
        • Features
        • Documentation
    • Upgrade Guide
      • Upgrading to 1.0.0
    • Future Releases
    • Release Notes Format
    • Versioning
    • Stay Updated
    • Links
AccessibleDjango
  • Search

© Copyright 2024, Johanan Oppong Amoateng.

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