GitXplorerGitXplorer
k

akka-html-docset

public
2 stars
0 forks
0 issues

Commits

List of commits on branch master.
Unverified
479da007440312e9d396afea79924dc9030ffedb

Update crawler.py

kknutwalker committed 11 years ago
Unverified
41ce2aba93d20a6edf4c333f710b665ddfa70488

generated based an akka-docs

kknutwalker committed 11 years ago
Unverified
6517810b64d3539c71394077e4d12fbd18ee025b

docset for 2.2.3

kknutwalker committed 11 years ago
Unverified
40b4e8d3125a0f1ea3a9f30b3ee43bd76f3e5d47

Initial commit

kknutwalker committed 11 years ago

README

The README file for this repository.

akka-html.docset

Dash docset for the HTML documentation of akka

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

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)

  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-repo>/akka-docs/target/sphinx/html to akka-html.docset/Contents/Resources/Documents/

  5. Run crawler.py in akka-html.docset/Contents/Resources (requires BeatufulSoup4)

  6. Restart Dash or re-add docset