This repository has been archived by the owner on Mar 21, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add basic check for toolbox documentation with denied access
See #2
- Loading branch information
Showing
2 changed files
with
12 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,11 @@ | ||
# MATLABfcnscrape | ||
Scrape MATLAB's documentation for all valid function names and output to JSON files for external use | ||
|
||
A JSON file is output per toolbox | ||
A JSON file is output per toolbox. All unique functions are also consolidated into a single JSON. | ||
|
||
## Notes | ||
Object methods (e.g. `cdflib.close`) are ignored for the JSON output | ||
* Only those toolboxes under the 'MATLAB Family' are considered at this time: https://www.mathworks.com/help/index.html | ||
* Several toolboxes are inaccessible by some users due to licensing restrictions | ||
* See [this issue](https://github.com/StackOverflowMATLABchat/MATLABfcnscrape/issues/2) for an up-to-date list | ||
* Pull requests for these toolboxes are welcome | ||
* Object methods (e.g. `cdflib.close`) are ignored for the JSON output |