This release is a pre-release and may not be stable for production use.
This package contains the MATLAB Sphinx domain and autodoc extensions.
Installation
Use Pip, Setuptools Easy Install or Python Distributions Utilities (Distutils).
Pip:
~$ pip install -U sphinxcontrib-matlabdomain
Easy Install:
~$ easy_install -U sphinxcontrib-matlabdomain
Distutils:
~/downloads$ curl https://pypi.python.org/packages/source/s/sphinxcontrib-matlabdomain/sphinxcontrib-matlabdomain-0.X.tar.gz ~/downloads$ tar -xf sphinxcontrib-matlabdomain-0.X.tar.gz ~/downloads$ cd sphinxcontrib_matlabdomain-0.X ~/downloads/sphinxcontrib_matlabdomain-0.X$ python setup.py install
Requirements
This package is an extension to Sphinx.
Usage
In general usage is the same as for documenting Python code.
Configuration
In your Sphinx conf.py file add sphinxcontrib.matlab to the list of extensions. To use auto-documentation features, also add sphinx.ext.autodoc to the list of extensions.
In order for the Sphinx MATLAB domain to auto-document MATLAB source code, set the config value of matlab_src_dir to the absolute path instead of adding them to sys.path. Currently only one MATLAB path can be specified, but all subfolders in that tree will be searched.
For convenience the primary domain can be set to mat.
Roles and Directives
Please see Sphinx Domains and sphinx.ext.autodoc for documentation on the use of roles and directives. MATLAB code can be documented using the following roles and directives:
Directive |
MATLAB object |
|---|---|
.. module:: foldername |
folders, packages and namespaces |
.. curremtmodule:: foldername |
|
.. automodule:: foldername |
|
:mod:`foldername` |
|
.. function:: funcname |
function definition and signature |
.. autofunction:: funcname() |
|
:func:`funcname` |
|
.. class:: classname() |
class definition and optional signature |
.. autoclass:: classname |
|
:class:`classname` |
|
.. method:: methname() |
method definition and signature |
.. automethod:: methname |
|
:meth:`methname` |
|
.. staticmethod:: statmethname() |
static method definition and signature |
.. automethod:: statmethname |
|
:meth:`methname` |
|
.. attribute:: attrname |
property definition |
.. autoattribute:: attrname |
|
:attr:`attrname` |
|
Several options are available for auto-directives.
:members: auto-document public members
:show-inheritance: list bases
:undoc-members: document members without docstrings
:annotation: specifies attribute annotation instead of default
There are also several config values that can be set in conf.py that will affect auto-docementation.
autoclass_content can be set to class, both or init, which determines which docstring is used for classes. The constructor docstring is used when this is set to init.
autodoc_member_order can be set to alphabetical, groupwise or bysource.
autodoc_default_flags can be set to a list of options to apply. Use the no-flag directive option to disable this config value once.
Example: given the following MATLAB source in folder test_data:
classdef MyHandleClass < handle & my.super.Class
% a handle class
%
% :param x: a variable
%% some comments
properties
x % a property
end
methods
function h = MyHandleClass(x)
h.x = x
end
function x = get.x(obj)
% how is this displayed?
x = obj.x
end
end
methods (Static)
function w = my_static_function(z)
% A static function in :class:`MyHandleClass`.
%
% :param z: input z
% :returns: w
w = z
end
end
end
Use the following to document:
Test Data
=========
This is the test data module.
.. automodule:: test_data
:mod:`test_data` is a really cool module.
My Handle Class
---------------
This is the handle class definition.
.. autoclass:: MyHandleClass
:show-inheritance:
:members:
Online Demo
The test docs in the repository are online here: http://bwanamarko.alwaysdata.net/matlabdomain/
Users
3 maintainers
Metadata
3 maintainers
Release files for sphinxcontrib-matlabdomain 0.2.7.dev20150620
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| sphinxcontrib-matlabdomain-0.2.7.dev20150620.tar.gz | 37.7 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sphinxcontrib_matlabdomain-0.2.7.dev20150620-py2-none-any.whl | Python 2 | none | any | Details |
Total release size: 77.1 kB
Release files / sphinxcontrib-matlabdomain-0.2.7.dev20150620.tar.gz
| Download URL | sphinxcontrib-matlabdomain-0.2.7.dev20150620.tar.gz |
|---|---|
| Size | 37.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c12b7f2fc245bca08af752939ef60f55c2c669fddaeb649e10121c8491269c42
|
|
BLAKE2b-256 checksum How to use checksums |
0b2ceb2e9b88da75a2bc740be1f5555a0bf28daa38d4825f1d997cbe2f7f94cc
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Release files / sphinxcontrib_matlabdomain-0.2.7.dev20150620-py2-none-any.whl
| Download URL | sphinxcontrib_matlabdomain-0.2.7.dev20150620-py2-none-any.whl |
|---|---|
| Size | 39.5 kB |
| Tags | Python 2 |
|
SHA-256 checksum How to use checksums |
93a9474bfbae20f652e5eb8787446126fd8e914b2449932ebc881fa546e6c75f
|
|
BLAKE2b-256 checksum How to use checksums |
77d351824ece2fc2f2d58dddfd2881d43c3cb68da6a258a5d2444e187c960c8c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for sphinxcontrib-matlabdomain 0.2.7.dev20150620
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
