phijor / agda-docsets

Dash/Zeal docset for various Agda libraries

Agda docsets for Dash/Zeal

This repository contains instructions for generating docsets of Agda libraries for the documentation viewers Dash and Zeal.

Currently, this repository builds docsets for the following libraries:

• standard-library: The Agda standard library, version v2.0
• cubical: A standard library for Cubical Agda, version v0.7

Generating docsets

With Nix installed and Flakes enabled, run

$ nix build

For each library <lib>, the directory result/<lib>-docset/ will contain the corresponding docset, i.e. a folder named <lib>.docset.

To generate individual docsets, run

$ nix build '.#<lib>-docset'

Installing docsets

To install a docset with Zeal, copy the generated <lib>.docset folder into "${XDG_DATA_HOME}/Zeal/Zeal/docsets", If ${XDG_DATA_HOME} is unset, copy the docset folder to $HOME/.local/share/Zeal/Zeal/docsets.

License

The files in this repository are licensed under the terms of the MIT license.