Skip to content
📄 Dash docset for AllenNLP
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.gitignore
AllenNLP.xml
README.md
icon.png
icon@2x.png
requirements.txt
screenshot.png

README.md

dash-docset-allennlp

screenshot

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

  • TODOs
    • Trim unnecessary fields
    • Automate docset generation process

Steps to generate the docset

  1. Build AllenNLP document with Sphinx
git clone git@github.com:allenai/allennlp.git
# Install dependencies, then
cd allennlp/doc
make html
  1. Convert html document to docset
doc2dash ${allennlp_path}/doc/html -n AllenNLP -I index.html
  1. 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

You can’t perform that action at this time.