rstbuddy
Getting Started
Installation Guide
Prerequisites
Installation Methods
Using uv (Recommended)
Using pipx
Using pip
From Source
Verification
Optional Dependencies
Pandoc Installation
OpenAI API Key Setup
Platform-Specific Instructions
macOS
Linux (Ubuntu/Debian)
Linux (CentOS/RHEL/Fedora)
Windows
Troubleshooting
Installation Issues
Verification Issues
Getting Help
Quickstart Guide
Prerequisites
Configuration
Basic Usage
Get Help
Check Links Usage
Fix RST Files Usage
AI Summarization Usage
Settings Usage
Output Formats
Next Steps
Getting Help
Common Workflows
Documentation Maintenance
Content Migration
Quality Assurance
User Guide
Using the Command Line Interface
Getting Help
Basic Help
Command Structure
Global Options
Check Links Command
Basic Usage
Command Options
What Gets Checked
Example Output
Fix Command
Basic Usage
What Gets Fixed
Example Output
Summarize Command
Basic Usage
What It Does
Requirements
Example Output
Version Command
Basic Usage
Example Output
Settings Command
Basic Usage
Example Output
Output Formats
Table Format (Default)
JSON Format
Text Format
Configuration
Examples
Basic Usage Examples
Advanced Usage Examples
Scripting Examples
Error Handling
Common Error Scenarios
Troubleshooting
Debugging Commands
Common Issues
Best Practices
Configuration: Command Line Tool
Configuration Methods
Configuration Files
File Locations
File Format
Configuration Options
Environment Variables
Environment Variable Mapping
Command-Line Options
Global Options
Option Reference
Configuration Examples
Basic Setup
Development Environment
Production Environment
AI Summarization Setup
Link Checking Configuration
Scripting Configuration
Security Considerations
Configuration File Security
Environment Variable Security
OpenAI API Key Security
Common Issues
Configuration Validation
Validation Rules
Error Messages
Best Practices
Configuration Management
Configuration Templates
Basic Template
AI Summarization Template
Frequently Asked Questions
Link Checking
Why are some links showing as broken when they work in my browser?
How can I tell if a link is actually broken or just blocked?
What should I do about robots.txt violations?
RST File Cleaning
Why isn’t rstbuddy fixing my Markdown headings?
How does rstbuddy decide what to fix?
AI Summarization
Why do I get “OpenAI API key required” errors?
Why do I get “pandoc: command not found” errors?
Performance and Configuration
Why is link checking so slow?
How can I customize what gets checked or fixed?
Output and Formatting
How can I integrate rstbuddy into my CI/CD pipeline?
Troubleshooting
How do I debug configuration issues?
What should I do if rstbuddy crashes or hangs?
Getting Help
Where can I get more help?
Development
Contributing
Instructions for contributors
Setting up your development environment
Python Conventions for this project
Managing dependencies
Testing
Updating the documentation
doc/source/index.rst
doc/source/changelog.rst
autodoc
etc.
Coding Standards
Code Style
Example Code Style
Testing Standards
Example Test Structure
Error Handling
Example Error Handling
Performance Considerations
Example Performance Optimization
Security Considerations
Example Security Implementation
Documentation Standards
Example API Documentation
Commit Standards
Example Commit Messages
Review Process
Getting Help
Reference
CHANGELOG
0.1.0 (YYYY-MM-DD)
Enhancements
rstbuddy
CHANGELOG
CHANGELOG
0.1.0 (YYYY-MM-DD)
Enhancements
Initial release.