.. sphinxcontrib-matlabdomain documentation master file

==========================
sphinxcontrib-matlabdomain
==========================

**A Sphinx extension for documenting MATLAB code**

sphinxcontrib-matlabdomain is a `Sphinx <https://www.sphinx-doc.org/>`_ 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
===========

* :doc:`getting-started/installation` - Install and set up in minutes
* :doc:`user-guide/configuration` - Configure for your project
* :doc:`user-guide/autodoc-directives` - Document MATLAB code automatically
* :doc:`developer-guide/contributing` - Contribute to the project

----

Getting Started
===============

New to Sphinx? Never used this extension before? These guides will get you up and running.

.. toctree::
   :maxdepth: 2
   :caption: Getting Started

   getting-started/installation
   getting-started/quick-start
   getting-started/first-project

----

User Guide
==========

Comprehensive documentation of all features for documenting MATLAB code.

.. toctree::
   :maxdepth: 2
   :caption: User Guide

   user-guide/configuration
   user-guide/autodoc-directives
   user-guide/sphinx-matlab-apidoc
   user-guide/matlab-domain
   user-guide/napoleon-docstrings
   user-guide/cross-referencing
   user-guide/examples
   user-guide/troubleshooting

----

Developer Guide
===============

Contributing to sphinxcontrib-matlabdomain? These guides cover architecture, testing, and development.

.. toctree::
   :maxdepth: 2
   :caption: Developer Guide

   developer-guide/architecture
   developer-guide/contributing
   developer-guide/testing
   developer-guide/known-issues
   developer-guide/quick-reference

----

Reference
=========

.. toctree::
   :maxdepth: 2
   :caption: Reference

   reference/configuration-options
   reference/directives
   reference/api
   reference/changelog

----

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`