search

sphinx-contrib / matlabdomain

A Sphinx extension for documenting Matlab code
http://sphinxcontrib-matlabdomain.readthedocs.io/
Other
70 stars 45 forks source link

Automodule of a Matlab package #26

Closed joeced closed 6 years ago

joeced commented 10 years ago

Originally reported by: Anonymous

Sphinx displays a warning when trying to automodule a Matlab package.

If I add the line 

.. automodule:: +myPackage

Sphinx displays:

WARNING: invalid signature for automodule (u'+myPackage')
WARNING: don't know which module to import for autodocumenting u'+myPackage' (try placing a "module" or "currentmodule" directive in the document, or giving an explicit module name)
joeced commented 6 years ago

Original comment by Mark Mikofski (Bitbucket: bwanamarko, GitHub: Unknown):

fixes #21 document packages and class folder almost

joeced commented 10 years ago

Original comment by Mark Mikofski (Bitbucket: bwanamarko, GitHub: Unknown):

@cpher this fix let's you document (and autodoc) matlab packages and class folders, but the method signatures in the methods block of the classdef will still cause sphinx-build to crash b/c Pygments doesn't recognize them, so we'll have to match them via regex and ignore them since the docstrings are in the method's file

joeced commented 10 years ago

Original comment by Mark Mikofski (Bitbucket: bwanamarko, GitHub: Unknown):

fixes #21 document packages and class folder almost

joeced commented 10 years ago

Original comment by Mark Mikofski (Bitbucket: bwanamarko, GitHub: Unknown):

changeset 8f18a8f should fix this

joeced commented 10 years ago

Original comment by Mark Mikofski (Bitbucket: bwanamarko, GitHub: Unknown):

closed accidentally when pulling from main upstream branch

joeced commented 10 years ago

Original comment by cpher (Bitbucket: cpher, GitHub: cpher):

The commit which closed this issue doesn't appear to have been related to the issue.

A similar issue will occur when working with a class defined in an @MyClass folder.