├── LICENSE ├── README.md ├── dashing.json ├── icon.png └── screenshot.png /LICENSE: -------------------------------------------------------------------------------- 1 | The Star And Thank Author License (SATA) 2 | 3 | Copyright (c) 2014 zTrix(i@ztrix.me) 4 | 5 | Project Url: https://github.com/ppwwyyxx/dash-docset-matlab 6 | 7 | Permission is hereby granted, free of charge, to any person obtaining a copy 8 | of this software and associated documentation files (the "Software"), to deal 9 | in the Software without restriction, including without limitation the rights 10 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 11 | copies of the Software, and to permit persons to whom the Software is 12 | furnished to do so, subject to the following conditions: 13 | 14 | The above copyright notice and this permission notice shall be included in 15 | all copies or substantial portions of the Software. 16 | 17 | And wait, the most important, you shall star/+1/like the project(s) in project url 18 | section above first, and then thank the author(s) in Copyright section. 19 | 20 | Here are some suggested ways: 21 | 22 | - Email the authors a thank-you letter, and make friends with him/her/them. 23 | - Report bugs or issues. 24 | - Tell friends what a wonderful project this is. 25 | - And, sure, you can just express thanks in your mind without telling the world. 26 | 27 | Contributors of this project by forking have the option to add his/her name and 28 | forked project url at copyright and project url sections, but shall not delete 29 | or modify anything else in these two sections. 30 | 31 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 32 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 33 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 34 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 35 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 36 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 37 | THE SOFTWARE. 38 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # dash-docset-matlab 2 | This is a [dashing](https://github.com/technosophos/dashing#readme) 3 | configuration file to help generate dash/zeal docset for Matlab. 4 | 5 | Matlab documentation was removed from dash official feeds at the request of MathWorks. 6 | But what's the matter if I just put a json here! 7 | 8 | # Steps to generate the docset 9 | + Install [dashing](https://github.com/technosophos/dashing#readme) 10 | + `cd MATLAB_ROOT/help` 11 | + `cp THIS_REPO/{dashing.json,icon.png} .` 12 | + Edit the version identifier in `dashing.json` if not using Matlab R2015b 13 | + `dashing build` will give you a `matlab.docset` folder. 14 | 15 | Right now this json only roughly parses function names (which is enough for me to use). 16 | Feel free to add more features and contribute! 17 | 18 | ![screenshot](/screenshot.png) 19 | -------------------------------------------------------------------------------- /dashing.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "matlab", 3 | "package": "matlab", 4 | "index": "documentation-center.html", 5 | "selectors": { 6 | ".function_ref h1.r2015b[itemprop=title]": "Function", 7 | ".class_ref h1.r2015b[itemprop=title]": "Class" 8 | }, 9 | "ignore": [ 10 | "ABOUT" 11 | ], 12 | "icon32x32": "icon.png", 13 | "allowJS": false 14 | } 15 | -------------------------------------------------------------------------------- /icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ppwwyyxx/dash-docset-matlab/1581d66efe3012d2529e6d5985a448f857f8c655/icon.png -------------------------------------------------------------------------------- /screenshot.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ppwwyyxx/dash-docset-matlab/1581d66efe3012d2529e6d5985a448f857f8c655/screenshot.png --------------------------------------------------------------------------------