https://github.com/pfefferle/dash-apidoc
An apiDoc Dash.app docset
https://github.com/pfefferle/dash-apidoc
apidoc dash docset
Last synced: about 1 year ago
JSON representation
An apiDoc Dash.app docset
- Host: GitHub
- URL: https://github.com/pfefferle/dash-apidoc
- Owner: pfefferle
- Created: 2015-05-28T21:31:13.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2017-01-07T20:22:12.000Z (over 9 years ago)
- Last Synced: 2025-03-30T11:24:31.987Z (about 1 year ago)
- Topics: apidoc, dash, docset
- Language: HTML
- Homepage: http://apidocjs.com
- Size: 841 KB
- Stars: 9
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# dash-apidoc
dash-apidoc is a docset for [Dash.app][] containing the latest [apiDoc documentation][].
## Installing
Install by opening Dash.app preferences, switch to `Downloads`, click `+`, and enter the feed URL
`https://raw.githubusercontent.com/pfefferle/dash-apidoc/master/apiDoc.xml`.
## Build
To rebuild or update this docset run the following commands in the following order:
1. `$ sh sync.sh` to grab the newest version of the documentation
1. `$ python rebuild.py` to generate the docset from the grabbed sources
1. `$ sh pack.sh` to build the tgz file for a new release
## Changelog
### 1.0.1
* updated docs
* removed JavaScripts
### 1.0.0
* initial
## Thanks
The [`sync.sh`][] and [`rebuild.py`][] scripts are based on [@willnorris][]' awesome [RFCDash Docset][] versions.
[Dash.app]: http://kapeli.com/dash
[apiDoc documentation]: http://apidocjs.com
[open an issue]: https://github.com/pfefferle/dash-apidoc/issues
[`pack.sh`]: https://github.com/pfefferle/dash-apidoc/blob/master/pack.sh
[`sync.sh`]: https://github.com/pfefferle/dash-apidoc/blob/master/sync.sh
[`rebuild.py`]: https://github.com/pfefferle/dash-apidoc/blob/master/rebuild.py
[@willnorris]: https://willnorris.com
[RFCDash Docset]: https://github.com/willnorris/rfcdash