dash-docset-allennlp
View AllenNLP docs in the dash offline docset browser.
To use, you can add this feed in Dash:
https://raw.githubusercontent.com/bckim92/dash-docset-allennlp/master/AllenNLP.xml
Or download the latest release here.
Notes
Steps to generate the docset
Build AllenNLP document with Sphinx
git clone git@github.com:allenai/allennlp.git
# Install dependencies, then
cd allennlp/doc
make html
Convert html document to docset
doc2dash ${allennlp_path}/doc/html -n AllenNLP -I index.html
Set additional configurations for docset
# Add icons
cp icon.png AllenNLP.docset/
cp icon@2x.png AllenNLP.docset/Contents/Resources/Documents/
# Set online redirection
vi AllenNLP.docset/Contents/Info.plist
# Add "<key>DashDocSetFallbackURL</key>" and "<string>https://allenai.github.io/allennlp-docs/</string>"
References