Skip to content

Home

Jump to bottom
Jørgen Cederberg edited this page May 16, 2023 · 6 revisions

Welcome to the sphinxcontrib-matlabdomain wiki!

The goal of this extension is to make it as easy as possible to create high-quality documentation using Sphinx for MATLAB projects. The major contribution of this extension is the ability to parse MATLAB source files and automatically put "docstrings" into Sphinx docs, and in the end typically make HTML or PDF documents.

The user should be able to make as few changes as possible in the MATLAB help text to accommodate Sphinx. Currently, a feature missing is the auto-linking of See Also lists. There you have to use reStructuredText style links: :class`package.ClassName`.

Plans

  • Auto-linking of "See Also" lists. (Also compatible with Napoleon) (#178 and #183)
  • Test if parallel_read_safe can be enabled. #147.
  • Revisit domain class to have it work with in-class reference #184.
  • Option to eliminate args from class signature #182.
  • Get class-folder classes to behave like regular classes #56.
  • Make new documentation site: github.io, read-the-docs, ?
  • Auto-summary feature akin to https://www.sphinx-doc.org/en/master/usage/extensions/autosummary.html
Clone this wiki locally