https://github.com/knutwalker/akka-html-docset
Dash docset for the HTML documentation of akka
https://github.com/knutwalker/akka-html-docset
Last synced: about 1 year ago
JSON representation
Dash docset for the HTML documentation of akka
- Host: GitHub
- URL: https://github.com/knutwalker/akka-html-docset
- Owner: knutwalker
- License: mit
- Created: 2014-02-22T15:51:46.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2014-02-22T17:53:59.000Z (over 12 years ago)
- Last Synced: 2025-04-02T13:25:56.451Z (about 1 year ago)
- Language: JavaScript
- Size: 2.33 MB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
akka-html.docset
================
[Dash](http://kapeli.com/dash) docset for the [HTML documentation of akka](http://doc.akka.io/docs/akka/2.2.3/index.html)
## Usage
1. clone this repository
2. add the `akka-html.docset` to your Docsets on Dash
- All pages are categorized as 'Guide'
- The pages `Java Documentation` and `Scala Documentation` have a [TOC](http://kapeli.com/guide/guide#tableOfContents)
### Update with wget
1. Download documentation
wget -r -k -L http://doc.akka.io/docs/akka/2.2.3/index.html
2. Move the contents of `doc.akka.io/docs/akka/2.2.3/` to `akka-html.docset/Contents/Resources/Documents/`
3. Run `crawler.py` in `akka-html.docset/Contents/Resources` (requires [BeatufulSoup4](http://www.crummy.com/software/BeautifulSoup/))
4. Restart Dash or re-add docset
### Update with akka-docs
1. Clone https://github.com/akka/akka.git somewhere
2. Checkout the desired version, e.g. `git checkout v.2.2.3`
3. Generate the documentation with `sbt make-site`
4. Move the contents of `/akka-docs/target/sphinx/html` to `akka-html.docset/Contents/Resources/Documents/`
5. Run `crawler.py` in `akka-html.docset/Contents/Resources` (requires [BeatufulSoup4](http://www.crummy.com/software/BeautifulSoup/))
6. Restart Dash or re-add docset