Skip to content

Commit 4b69dfb

Browse files
authored
Fix documentation/image links (#4025)
* Fix documentation/image links * Fix sphinx warnings
1 parent 8dfcaf8 commit 4b69dfb

File tree

3 files changed

+7
-8
lines changed

3 files changed

+7
-8
lines changed

Diff for: docs/contributing/contributing.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -221,7 +221,7 @@ Run the benchmarks with `cabal bench`.
221221

222222
It should take around 25 minutes and the results will be stored in the `bench-results` folder. To interpret the results, see the comments in the `bench/Main.hs` module.
223223

224-
More details in [bench/README](../../bench/README.md)
224+
More details in [bench/README](https://github.com/haskell/haskell-language-server/blob/master/bench/README.md)
225225

226226
### Tracing
227227

@@ -233,7 +233,7 @@ Adding support for new editors is fairly easy if the editor already has good sup
233233
In that case, there will likely be an editor-specific support system for this (like `lsp-mode` for Emacs).
234234
This will typically provide instructions for how to support new languages.
235235

236-
In some cases you may need to write a small bit of additional client support, or expose a way for the user to set the server's [configuration options](#configuring-haskell-language-server) and
236+
In some cases you may need to write a small bit of additional client support, or expose a way for the user to set the server's [configuration options](../configuration.md#configuring-haskell-language-server) and
237237
for them to configure how the server is started.
238238

239239
## Building the docs

Diff for: docs/contributing/index.rst

-1
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,3 @@ Contributing
66

77
contributing
88
plugin-tutorial
9-
releases

Diff for: docs/features.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ Provided by: `hls-call-hierarchy-plugin`
138138

139139
Shows ingoing and outgoing calls for a function.
140140

141-
![Call Hierarchy in VSCode](https://github.com/haskell/haskell-language-server/raw/2857eeece0398e1cd4b2ffb6069b05c4d2308b39/plugins/hls-call-hierarchy-plugin/call-hierarchy-in-vscode.gif)
141+
![Call Hierarchy in VSCode](../plugins/hls-call-hierarchy-plugin/call-hierarchy-in-vscode.gif)
142142

143143
## Highlight references
144144

@@ -199,7 +199,7 @@ Rewrites imported names to be qualified.
199199

200200
![Qualify Imported Names Demo](../plugins/hls-qualify-imported-names-plugin/qualify-imported-names-demo.gif)
201201

202-
For usage see the ![readme](../plugins/hls-qualify-imported-names-plugin/README.md).
202+
For usage see the [readme](https://github.com/haskell/haskell-language-server/blob/master/plugins/hls-qualify-imported-names-plugin/README.md).
203203

204204
### Add missing class methods
205205

@@ -264,7 +264,7 @@ Known Limitations:
264264

265265
![Change Type Signature Demo](../plugins/hls-change-type-signature-plugin/change2.gif)
266266

267-
![Link to Docs](../plugins/hls-change-type-signature-plugin/README.md)
267+
[Link to Docs](https://github.com/haskell/haskell-language-server/blob/master/plugins/hls-change-type-signature-plugin/README.md)
268268

269269
### Add argument to function
270270

@@ -284,7 +284,7 @@ Convert a datatype to GADT syntax.
284284

285285
![GADT Demo](../plugins/hls-gadt-plugin/gadt.gif)
286286

287-
![Link to Docs](../plugins/hls-gadt-plugin/README.md)
287+
[Link to Docs](https://github.com/haskell/haskell-language-server/blob/master/plugins/hls-gadt-plugin/README.md)
288288

289289
### Expand record wildcard
290290

@@ -318,7 +318,7 @@ Provided by: `hls-eval-plugin`
318318

319319
Evaluates code blocks in comments with a click. [Tutorial](https://github.com/haskell/haskell-language-server/blob/master/plugins/hls-eval-plugin/README.md).
320320

321-
![Eval Demo](https://raw.githubusercontent.com/haskell/haskell-language-server/master/plugins/hls-eval-plugin/demo.gif)
321+
![Eval Demo](../plugins/hls-eval-plugin/demo.gif)
322322

323323
Known limitations:
324324

0 commit comments

Comments
 (0)