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

Added support for documenting MATLAB application files #97

Merged
merged 1 commit into from
Oct 29, 2019

Conversation

ilent2
Copy link
Contributor

@ilent2 ilent2 commented Oct 29, 2019

This commit adds support for documenting the .mlapp application files.

The documentation is sourced from the app metadata XML files, the reader
uses ElementTree and ZipFile to read the .mlapp file and parse the XML files.

I've added an example application file from R2018a. It is probably a good idea to
test it with a more recent Matlab version too.

To document apps I've added an application directive and a app reference
and an example usage to tests/test_docs/index.rst

It might be good to add other options for displaying additional information, such
as which version the mlapp is was built with, including the preview image, or
toggling the inclusion of the summary or description text.

- Sources the summary and description from the app metadata.
- Added an ``application`` directive and a ``app`` reference.
- Added example usage to tests/test_docs/index.rst
@joeced
Copy link
Collaborator

joeced commented Oct 29, 2019

@ilent2 Thanks for the contribution. I've never used .mlapp's myself, thus never had the need for adding it. As with #96 , I'll try to get a new release out this week.

@joeced joeced merged commit 2a3edd9 into sphinx-contrib:master Oct 29, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants