This repository will automatically clone and generate a valid Dash Docset for XMPP XEPs.

The source XEPs to be included in the resulting docset are pulled automatically from the respective repository. Pulling and keeping this up-to-date is important in being able to build a useful doc-set, and you can do this like so:

git submodule update --remote --recursive

Building the docset might fail if the above was not done and this repository wasn't cloned via git clone --recursive.

Building a new Docset requires a single command and a few dependencies:

• envsubst for creating an info file from the templated source.
• sqlite3 for adding entries for XEPs in the embedded Dash database.
• xmllint and xsltproc for actually building the HTML files for the XML source.
• tar and gzip for building the final package.

With these dependencies in place, you can just run make in the root directory of the repository.

You can install the resulting docset by either using the build/XEPs.tgz package directly, or, alternatively, by using the feed hosted here, the URL for which is:

https://raw.githubusercontent.com/deuill/xmpp-xep-dash-docset/trunk/XEPs.xml

Copying this into your application of choice (Dash, Zeal, etc.) should automatically pull in any future updates to the docset.

All code in this repository is covered by the terms of the MIT License, the full text of which can be found in the LICENSE file.

All other code, images, etc. are property of their respective owners.