Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Matlab autosummary #211

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,5 @@ _build
htmlcov
.coverage
build/

generated
32 changes: 32 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,7 @@ Directive MATLAB object
``.. application:: appname`` **application definition**
``.. autoapplication:: appname`` * auto-document
``:app:`appname``` * reference
``.. autosummary`` **Generate autodoc summaries**
==================================== ===========================================

Several options are available for auto-directives.
Expand Down Expand Up @@ -276,6 +277,37 @@ Instead use the ``mat:`` prefix before the desired directives::
.. mat:automodule:: matsrc
.. mat:autofunction:: matsrc.func

Autosummary
===========

Mailly base on `sphinx.ext.autosummary <https://www.sphinx-doc.org/en/master/usage/extensions/autosummary.html>`_. The
``.. autosummary::`` directive can be used to generate a summary table of the MATLAB modules or MATLAB functions and classes in a module.

Example::

.. autosummary for modules
.. autosummary::
:toctree: generated/

folder1
folder2

.. autosummary for functions and classes
.. currentmodule:: <module_name>
.. autosummary::
:toctree: generated/

func1
func2
class1
class2

More details can be found in the `sphinx.ext.autosummary <https://www.sphinx-doc.org/en/master/usage/extensions/autosummary.html>`_.
And test examples can be found in the ``test_doc_autosummary``.

.. note::

May not be compatible with ``sphinx.ext.autosummary``.

Online Demo
===========
Expand Down
Loading