https://github.com/jml/open-haddock
Quickly open documentation for Haskell packages or modules from the command line
https://github.com/jml/open-haddock
Last synced: about 1 year ago
JSON representation
Quickly open documentation for Haskell packages or modules from the command line
- Host: GitHub
- URL: https://github.com/jml/open-haddock
- Owner: jml
- License: gpl-3.0
- Created: 2015-10-30T17:27:28.000Z (over 10 years ago)
- Default Branch: main
- Last Pushed: 2021-01-16T09:48:57.000Z (over 5 years ago)
- Last Synced: 2025-03-23T20:51:14.174Z (about 1 year ago)
- Language: Haskell
- Size: 19.5 KB
- Stars: 4
- Watchers: 3
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# open-haddock
_Quickly open documentation for Haskell packages or modules from the command
line_
## Motivation
This is for any Haskell programmer who has wanted to:
* look up documentation while offline
* find the documentation for the version of the package they actually have,
rather than whatever the latest version happens to be
In particular, if you use nix or cabal sandboxes, this is the command-line
tool for you.
All you have to do is run `open-haddock` followed by either the name of a
package (e.g. `text`) or the name of a module (e.g. `Control.Monad`).
## Examples
```
$ open-haddock Data.Text
```
```
$ open-haddock text
```
```
$ open-haddock --dry-run Turtle.Options
/nix/store/n3rgkskgjdph4ykqi845z5ayspzqbfqr-turtle-1.2.2/share/doc/x86_64-osx-ghc-7.10.2/turtle-1.2.2/html/Turtle-Options.html
```
```
$ open-haddock --dry-run turtle
/nix/store/n3rgkskgjdph4ykqi845z5ayspzqbfqr-turtle-1.2.2/share/doc/x86_64-osx-ghc-7.10.2/turtle-1.2.2/html/index.html
```
## Installation
Download the source from https://github.com/jml/open-haddock/ and install
using either `cabal` or `nix`.