acbetter / matlab-to-dash-docset

Convert MATLAB Help Document to Docset for the Dash app on Mac

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

MATLAB to Dash Docset

Convert MATLAB Help Document to Docset for Dash.app to use. Supported MATLAB Version: R2015a-R2018a

image

How to Use?

Open Termainal.app and input this command if you use Homebrew:

brew tap acbetter/tap && brew install matlab2dash
matlab2dash

Please wait for a minute...

asciicast

The script will auto find the MATLAB.app which was installed in your computer and create the docset file in your ~/Downloads directory. The size of the docset file will be about 1.6 GB, so please wait it.

Why 1.6 GB? Because of the new verison Dash doesn't support os.symlink feature, so I can't use system link to link the docset. So the docset file copy all the MATLAB.app help documents which is about 1.6 GB...

If you don't use Homebrew, please open our releases page and download the binary file (about 10 MB). Then you can use the command chmod +x matlab2dash && ./matlab2dash to run it after you have changed your directory.

Contact and Bugs Report

Please post bugs and issues on github. Thank you!

LICENSE

MIT

中文简介

本程序可以把 MATLAB.app 自带的帮助文档转换成 Dash.app 可以使用的文档。

About

Convert MATLAB Help Document to Docset for the Dash app on Mac

License:Apache License 2.0


Languages

Language:Python 100.0%