Skip to content

Commit 2317272

Browse files
committed
Add info on generating docs, fixes #44
1 parent ede729e commit 2317272

File tree

1 file changed

+29
-2
lines changed

1 file changed

+29
-2
lines changed

README.md

Lines changed: 29 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,11 @@ The language client requires you to manually install the [HIE](https://github.co
88

99
```bash
1010
$ git clone https://github.com/haskell/haskell-ide-engine
11-
$ cd haskell-ide-engine
12-
$ stack install
11+
$ cd haskell-ide-engine && make build
1312
```
1413

14+
Alternatively you can just `stack install`, but `make build` will give you the best setup.
15+
1516
## Features
1617
Language server client for haskell using the [HIE](https://github.com/haskell/haskell-ide-engine) language server. Supports,
1718

@@ -82,6 +83,32 @@ If you `hie` executable is not on your path, you can manually set it,
8283

8384
The path placeholders work here as well. Note that this adds the `--lsp` argument to the call of this executable.
8485

86+
## Docs on Hover/Generating Hoogle DB
87+
For the most current documentation on this, see [Docs on Hover/Completion](https://github.com/haskell/haskell-ide-engine#docs-on-hovercompletion).
88+
89+
HIE supports fetching docs from haddock on hover. It will fallback on using a hoogle db(generally located in ~/.hoogle on linux)
90+
if no haddock documentation is found.
91+
92+
To generate haddock documentation for stack projects:
93+
94+
```bash
95+
$ cd your-project-directory
96+
$ stack haddock --keep-going
97+
```
98+
99+
To enable documentation generation for cabal projects, add the following to your ~/.cabal/config
100+
101+
```
102+
documentation: True
103+
```
104+
105+
To generate a hoogle database that hie can use
106+
107+
```bash
108+
$ cd haskell-ide-engine
109+
$ stack --stack-yaml=<stack.yaml you used to build hie> exec hoogle generate
110+
```
111+
85112
## Manual Installation
86113
Either install the extension via the marketplace (preferred), or if you are testing an unreleased version by,
87114

0 commit comments

Comments
 (0)