Skip to content
This repository was archived by the owner on Mar 21, 2024. It is now read-only.

Commit 883a4a9

Browse files
committed
Update README
1 parent f75ff0c commit 883a4a9

File tree

1 file changed

+42
-6
lines changed

1 file changed

+42
-6
lines changed

README.md

Lines changed: 42 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,45 @@
11
# MATLABfcnscrape
2-
Scrape MATLAB's documentation for all function names and output to JSON files for external use
2+
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
3+
[![Code style: black](https://img.shields.io/badge/code%20style-black-black)](https://github.com/psf/black)
34

4-
A JSON file is output per toolbox. All unique functions are also consolidated into a single JSON.
5+
Scrape MATLAB's documentation for (hopefully) all function names and output to JSON files for your reading pleasure.
56

6-
## Notes
7-
* Only those toolboxes under the 'MATLAB Family' are considered at this time: https://www.mathworks.com/help/index.html
8-
* Several toolboxes are inaccessible by some users due to licensing restrictions
9-
* See [this issue](https://github.com/StackOverflowMATLABchat/MATLABfcnscrape/issues/2) for more information
7+
For each MATLAB release, a JSON file is output per toolbox and all unique functions are consolidated into a single JSON.
8+
9+
## Caveats
10+
* For TOS compliance, only public facing documentation is accessed
11+
* See [this issue](https://github.com/StackOverflowMATLABchat/MATLABfcnscrape/issues/2) for additional information
12+
* These listings are not guaranteed to be comprehensive
13+
* The filtering mechanism is continually being improved in order to provide the best possible listing of "actual" functions without requiring significant manual intervention
14+
* Only those toolboxes under the 'MATLAB Family' are considered at this time; toolboxes under the 'Simulink Family' and any other hardware-specific toolboxes are (mostly) filtered out as their functions are generally linked to the "block" coding rather than the editor
15+
16+
## MATLABfcnscrape CLI
17+
Assuming MATLABfcnscrape is installed in the current environment, it can be invoked directly from the command line:
18+
19+
```bash
20+
$ fcnscrape
21+
Usage: fcnscrape [OPTIONS] COMMAND [ARGS]...
22+
23+
Scrape MATLABs online documentation for all function names.
24+
25+
Options:
26+
--install-completion Install completion for the current shell.
27+
--show-completion Show completion for the current shell, to copy it or
28+
customize the installation.
29+
30+
--help Show this message and exit.
31+
32+
Commands:
33+
run Run the documentation scraping pipeline for the specified release.
34+
```
35+
36+
### `fcnscrape run`
37+
Invokes the main scraping pipeline
38+
#### Input Parameters
39+
| Parameter | Description | Default |
40+
|--------------------------------------------|------------------------|------------------------|
41+
| `--force-new-cache / --no-force-new-cache` | Force URL cache update | `--no-force-new-cache` |
42+
43+
44+
## Repository Tags
45+
In addition to tags for releases of the tool, tags are also added to commits adding (or updating) listings for specific releases. Initial releases are tagged as the major version, e.g. `R2020b`, with any updates tagged with a dash suffix, e.g. (`R2020b-1`)

0 commit comments

Comments
 (0)