sphinxcontrib-matlabdomain
A Sphinx extension for documenting MATLAB code
sphinxcontrib-matlabdomain is a Sphinx extension that provides automatic documentation generation from MATLAB source files, similar to Python’s autodoc. It allows you to keep your documentation and source code together while leveraging Sphinx’s powerful documentation tools.
Note
This documentation is organized into three main sections:
Getting Started - New to Sphinx or this extension? Start here!
User Guide - Comprehensive feature documentation and examples
Developer Guide - Contributing to the project
Quick Links
Installation - Install and set up in minutes
Configuration - Configure for your project
Autodoc Directives - Document MATLAB code automatically
Contributing - Contribute to the project
Getting Started
New to Sphinx? Never used this extension before? These guides will get you up and running.
Getting Started
- Installation
- Quick Start
- Your First Project
- Project Setup
- Step 1: Install Prerequisites
- Step 2: Create Documentation Directory
- Step 3: Configure for MATLAB
- Step 4: Create MATLAB Source Files
- Step 5: Generate API docs with
sphinx-matlab-apidoc - Step 6: Build Your Documentation
- Step 7: View Your Documentation
- Understanding What Happened
- Customizing Your Documentation
- Next Steps
- Common Issues
User Guide
Comprehensive documentation of all features for documenting MATLAB code.
Developer Guide
Contributing to sphinxcontrib-matlabdomain? These guides cover architecture, testing, and development.
Developer Guide